From d31a597f5aa0eaa5e4cfe0832c5ecfcbd5bbbe9a Mon Sep 17 00:00:00 2001 From: Yixing Lao Date: Sat, 28 Dec 2024 20:22:24 +0800 Subject: [PATCH] docs(api.rst): add table of contents and internal references for better navigation and structure --- docs/api.rst | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 07438a07..d4447aac 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,7 +1,16 @@ API Reference ============= -This section provides detailed API documentation for all CamTools modules. +- :ref:`ct.camera ` +- :ref:`ct.colmap ` +- :ref:`ct.convert ` +- :ref:`ct.io ` +- :ref:`ct.metric ` +- :ref:`ct.project ` +- :ref:`ct.raycast ` +- :ref:`ct.render ` + +.. _ct-camera: > ct.camera =========== @@ -13,6 +22,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-colmap: + > ct.colmap =========== @@ -23,6 +34,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-convert: + > ct.convert =========== @@ -33,6 +46,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-io: + > ct.io ======= @@ -43,6 +58,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-metric: + > ct.metric =========== @@ -53,6 +70,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-project: + > ct.project =========== @@ -63,6 +82,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-raycast: + > ct.raycast =========== @@ -73,6 +94,8 @@ This section provides detailed API documentation for all CamTools modules. :undoc-members: :show-inheritance: +.. _ct-render: + > ct.render ===========