Skip to content

Commit

Permalink
docs: add API reference documentation and update Sphinx configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
yxlao committed Dec 28, 2024
1 parent 598ec3c commit 2924265
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 1 deletion.
66 changes: 66 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
API Reference
============

Camera Operations
---------------

.. automodule:: camtools.camera
:members:
:undoc-members:
:show-inheritance:

Coordinate Conversion
-------------------

.. automodule:: camtools.convert
:members:
:undoc-members:
:show-inheritance:

Image and Depth I/O
-----------------

.. automodule:: camtools.io
:members:
:undoc-members:
:show-inheritance:

Projection
---------

.. automodule:: camtools.project
:members:
:undoc-members:
:show-inheritance:

Ray Casting
----------

.. automodule:: camtools.raycast
:members:
:undoc-members:
:show-inheritance:

COLMAP Tools
-----------

.. automodule:: camtools.colmap
:members:
:undoc-members:
:show-inheritance:

Image Metrics
------------

.. automodule:: camtools.metric
:members:
:undoc-members:
:show-inheritance:

Rendering
--------

.. automodule:: camtools.render
:members:
:undoc-members:
:show-inheritance:
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,5 @@
autodoc_member_order = "bysource"
autodoc_typehints = "description"
autodoc_typehints_description_target = "documented"
add_module_names = False
add_module_names = True
python_use_unqualified_type_names = False

0 comments on commit 2924265

Please sign in to comment.