switch to sphinx

photon-lib/py/docs/source/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "PhotonVision"
+copyright = "2025, Matt Morley, Banks Troutman"
+author = "Matt Morley, Banks Troutman"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",  # for Google/NumPy docstrings
+    "sphinx_autodoc_typehints",  # for type hints in docs
+]
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))  # adjust based on your project layout
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]

photon-lib/py/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. PhotonVision documentation master file, created by
+   sphinx-quickstart on Fri May  9 12:16:37 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+PhotonVision documentation
+==========================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:

photon-lib/py/docs/source/modules.rst

@@ -0,0 +1,7 @@
+photonlibpy
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   photonlibpy

photon-lib/py/docs/source/photonlibpy.estimation.rst

@@ -0,0 +1,53 @@
+photonlibpy.estimation package
+==============================
+
+Submodules
+----------
+
+photonlibpy.estimation.cameraTargetRelation module
+--------------------------------------------------
+
+.. automodule:: photonlibpy.estimation.cameraTargetRelation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.estimation.openCVHelp module
+----------------------------------------
+
+.. automodule:: photonlibpy.estimation.openCVHelp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.estimation.rotTrlTransform3d module
+-----------------------------------------------
+
+.. automodule:: photonlibpy.estimation.rotTrlTransform3d
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.estimation.targetModel module
+-----------------------------------------
+
+.. automodule:: photonlibpy.estimation.targetModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.estimation.visionEstimation module
+----------------------------------------------
+
+.. automodule:: photonlibpy.estimation.visionEstimation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.estimation
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.generated.rst

@@ -0,0 +1,61 @@
+photonlibpy.generated package
+=============================
+
+Submodules
+----------
+
+photonlibpy.generated.MultiTargetPNPResultSerde module
+------------------------------------------------------
+
+.. automodule:: photonlibpy.generated.MultiTargetPNPResultSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.generated.PhotonPipelineMetadataSerde module
+--------------------------------------------------------
+
+.. automodule:: photonlibpy.generated.PhotonPipelineMetadataSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.generated.PhotonPipelineResultSerde module
+------------------------------------------------------
+
+.. automodule:: photonlibpy.generated.PhotonPipelineResultSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.generated.PhotonTrackedTargetSerde module
+-----------------------------------------------------
+
+.. automodule:: photonlibpy.generated.PhotonTrackedTargetSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.generated.PnpResultSerde module
+-------------------------------------------
+
+.. automodule:: photonlibpy.generated.PnpResultSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.generated.TargetCornerSerde module
+----------------------------------------------
+
+.. automodule:: photonlibpy.generated.TargetCornerSerde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.generated
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.networktables.rst

@@ -0,0 +1,21 @@
+photonlibpy.networktables package
+=================================
+
+Submodules
+----------
+
+photonlibpy.networktables.NTTopicSet module
+-------------------------------------------
+
+.. automodule:: photonlibpy.networktables.NTTopicSet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.networktables
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.rst

@@ -0,0 +1,58 @@
+photonlibpy package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   photonlibpy.estimation
+   photonlibpy.generated
+   photonlibpy.networktables
+   photonlibpy.simulation
+   photonlibpy.targeting
+   photonlibpy.timesync
+
+Submodules
+----------
+
+photonlibpy.estimatedRobotPose module
+-------------------------------------
+
+.. automodule:: photonlibpy.estimatedRobotPose
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.packet module
+-------------------------
+
+.. automodule:: photonlibpy.packet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.photonCamera module
+-------------------------------
+
+.. automodule:: photonlibpy.photonCamera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.photonPoseEstimator module
+--------------------------------------
+
+.. automodule:: photonlibpy.photonPoseEstimator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.simulation.rst

@@ -0,0 +1,53 @@
+photonlibpy.simulation package
+==============================
+
+Submodules
+----------
+
+photonlibpy.simulation.photonCameraSim module
+---------------------------------------------
+
+.. automodule:: photonlibpy.simulation.photonCameraSim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.simulation.simCameraProperties module
+-------------------------------------------------
+
+.. automodule:: photonlibpy.simulation.simCameraProperties
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.simulation.videoSimUtil module
+------------------------------------------
+
+.. automodule:: photonlibpy.simulation.videoSimUtil
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.simulation.visionSystemSim module
+---------------------------------------------
+
+.. automodule:: photonlibpy.simulation.visionSystemSim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.simulation.visionTargetSim module
+---------------------------------------------
+
+.. automodule:: photonlibpy.simulation.visionTargetSim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.simulation
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.targeting.rst

@@ -0,0 +1,45 @@
+photonlibpy.targeting package
+=============================
+
+Submodules
+----------
+
+photonlibpy.targeting.TargetCorner module
+-----------------------------------------
+
+.. automodule:: photonlibpy.targeting.TargetCorner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.targeting.multiTargetPNPResult module
+-------------------------------------------------
+
+.. automodule:: photonlibpy.targeting.multiTargetPNPResult
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.targeting.photonPipelineResult module
+-------------------------------------------------
+
+.. automodule:: photonlibpy.targeting.photonPipelineResult
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+photonlibpy.targeting.photonTrackedTarget module
+------------------------------------------------
+
+.. automodule:: photonlibpy.targeting.photonTrackedTarget
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.targeting
+   :members:
+   :undoc-members:
+   :show-inheritance:

photon-lib/py/docs/source/photonlibpy.timesync.rst

@@ -0,0 +1,21 @@
+photonlibpy.timesync package
+============================
+
+Submodules
+----------
+
+photonlibpy.timesync.timeSyncServer module
+------------------------------------------
+
+.. automodule:: photonlibpy.timesync.timeSyncServer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: photonlibpy.timesync
+   :members:
+   :undoc-members:
+   :show-inheritance: