refactor(docs): restructure API reference into separate files for bet…

…ter organization and maintainability
yxlao · Dec 28, 2024 · c529c76 · c529c76
1 parent 8a83030
commit c529c76
Show file tree

Hide file tree

Showing 9 changed files with 83 additions and 104 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,107 +1,14 @@
 API Reference
 =============
 
-- :ref:`ct.camera <ct-camera>`
-- :ref:`ct.colmap <ct-colmap>`
-- :ref:`ct.convert <ct-convert>`
-- :ref:`ct.io <ct-io>`
-- :ref:`ct.metric <ct-metric>`
-- :ref:`ct.project <ct-project>`
-- :ref:`ct.raycast <ct-raycast>`
-- :ref:`ct.render <ct-render>`
-
-.. _ct-camera:
-
-``> ct.camera``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.camera
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-colmap:
-
-``> ct.colmap``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.colmap
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-convert:
-
-``> ct.convert``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.convert
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-io:
-
-``> ct.io``
-=======
-
-.. currentmodule:: ct
-
-.. automodule:: ct.io
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-metric:
-
-``> ct.metric``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.metric
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-project:
-
-``> ct.project``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.project
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-raycast:
-
-``> ct.raycast``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.raycast
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. _ct-render:
-
-``> ct.render``
-===========
-
-.. currentmodule:: ct
-
-.. automodule:: ct.render
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. toctree::
+   :maxdepth: 2
+
+   camera
+   colmap
+   convert
+   io
+   metric
+   project
+   raycast
+   render
diff --git a/docs/camera.rst b/docs/camera.rst
@@ -0,0 +1,9 @@
+ct.camera
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/colmap.rst b/docs/colmap.rst
@@ -0,0 +1,9 @@
+ct.colmap
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.colmap
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/convert.rst b/docs/convert.rst
@@ -0,0 +1,9 @@
+ct.convert
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.convert
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/io.rst b/docs/io.rst
@@ -0,0 +1,9 @@
+ct.io
+=======
+
+.. currentmodule:: ct
+
+.. automodule:: ct.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/metric.rst b/docs/metric.rst
@@ -0,0 +1,9 @@
+ct.metric
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.metric
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/project.rst b/docs/project.rst
@@ -0,0 +1,9 @@
+ct.project
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.project
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/raycast.rst b/docs/raycast.rst
@@ -0,0 +1,9 @@
+ct.raycast
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.raycast
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/render.rst b/docs/render.rst
@@ -0,0 +1,9 @@
+ct.render
+=========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.render
+   :members:
+   :undoc-members:
+   :show-inheritance: