docs: consolidate API reference into a single file and remove individ…

…ual module files docs: update index.rst to reduce toctree maxdepth for better navigation
yxlao · Dec 28, 2024 · d4790c7 · d4790c7
1 parent 68f50c7
commit d4790c7
Show file tree

Hide file tree

Showing 10 changed files with 84 additions and 86 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,14 +1,84 @@
 API Reference
-==============
-
-.. toctree::
-   :maxdepth: 2
-
-   api/camera
-   api/colmap
-   api/convert
-   api/io
-   api/metric
-   api/project
-   api/raycast
-   api/render
+=============
+
+This section provides detailed API documentation for all CamTools modules.
+
+> ct.camera
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.colmap
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.colmap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.convert
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.convert
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.io
+=======
+
+.. currentmodule:: ct
+
+.. automodule:: ct.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.metric
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.metric
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.project
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.project
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.raycast
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.raycast
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+> ct.render
+===========
+
+.. currentmodule:: ct
+
+.. automodule:: ct.render
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/camera.rst b/docs/api/camera.rst
diff --git a/docs/api/colmap.rst b/docs/api/colmap.rst
diff --git a/docs/api/convert.rst b/docs/api/convert.rst
diff --git a/docs/api/io.rst b/docs/api/io.rst
diff --git a/docs/api/metric.rst b/docs/api/metric.rst
diff --git a/docs/api/project.rst b/docs/api/project.rst
diff --git a/docs/api/raycast.rst b/docs/api/raycast.rst
diff --git a/docs/api/render.rst b/docs/api/render.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -25,7 +25,7 @@ clear and easy-to-use APIs.
    </p>
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Docs
 
    Home <self>