Skip to content

Commit

Permalink
docs(api.rst): add table of contents and internal references for bett…
Browse files Browse the repository at this point in the history
…er navigation and structure
  • Loading branch information
yxlao committed Dec 28, 2024
1 parent d4790c7 commit d31a597
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
API Reference
=============

This section provides detailed API documentation for all CamTools modules.
- :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
===========
Expand All @@ -13,6 +22,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-colmap:

> ct.colmap
===========

Expand All @@ -23,6 +34,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-convert:

> ct.convert
===========

Expand All @@ -33,6 +46,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-io:

> ct.io
=======

Expand All @@ -43,6 +58,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-metric:

> ct.metric
===========

Expand All @@ -53,6 +70,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-project:

> ct.project
===========

Expand All @@ -63,6 +82,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-raycast:

> ct.raycast
===========

Expand All @@ -73,6 +94,8 @@ This section provides detailed API documentation for all CamTools modules.
:undoc-members:
:show-inheritance:

.. _ct-render:

> ct.render
===========

Expand Down

0 comments on commit d31a597

Please sign in to comment.