add docs for python

This commit is contained in:
samfreund
2025-04-12 17:12:13 -05:00
parent 35c72e8446
commit 47b799a0ce
6 changed files with 47 additions and 0 deletions

View File

@@ -0,0 +1,3 @@
# EstimatedRobotPose API
::: photonlibpy.estimatedRobotPose

View File

@@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

View File

@@ -0,0 +1,3 @@
# Packet API
::: photonlibpy.packet

View File

@@ -0,0 +1,3 @@
# PhotonCamera API
::: photonlibpy.photonCamera

View File

@@ -0,0 +1,3 @@
# Photon Pose Estimator API
::: photonlibpy.photonPoseEstimator

18
photon-lib/py/mkdocs.yml Normal file
View File

@@ -0,0 +1,18 @@
site_name: PhotonVision Python API Docs
theme:
name: material
plugins:
- search
- mkdocstrings:
default_handler: python
nav:
- Home: index.md
- API Reference:
- PhotonCamera: photonCamera.md
- EstimatedRobotPose: estimatedRobotPose.md
- Packet: packet.md
- PhotonPoseEstimator: photonPoseEstimator.md