From 47b799a0ceb16b3cf35b092f92c55e9dea857e50 Mon Sep 17 00:00:00 2001 From: samfreund Date: Sat, 12 Apr 2025 17:12:13 -0500 Subject: [PATCH] add docs for python --- photon-lib/py/docs/estimatedRobotPose.md | 3 +++ photon-lib/py/docs/index.md | 17 +++++++++++++++++ photon-lib/py/docs/packet.md | 3 +++ photon-lib/py/docs/photonCamera.md | 3 +++ photon-lib/py/docs/photonPoseEstimator.md | 3 +++ photon-lib/py/mkdocs.yml | 18 ++++++++++++++++++ 6 files changed, 47 insertions(+) create mode 100644 photon-lib/py/docs/estimatedRobotPose.md create mode 100644 photon-lib/py/docs/index.md create mode 100644 photon-lib/py/docs/packet.md create mode 100644 photon-lib/py/docs/photonCamera.md create mode 100644 photon-lib/py/docs/photonPoseEstimator.md create mode 100644 photon-lib/py/mkdocs.yml diff --git a/photon-lib/py/docs/estimatedRobotPose.md b/photon-lib/py/docs/estimatedRobotPose.md new file mode 100644 index 000000000..506e8adf8 --- /dev/null +++ b/photon-lib/py/docs/estimatedRobotPose.md @@ -0,0 +1,3 @@ +# EstimatedRobotPose API + +::: photonlibpy.estimatedRobotPose diff --git a/photon-lib/py/docs/index.md b/photon-lib/py/docs/index.md new file mode 100644 index 000000000..000ea3455 --- /dev/null +++ b/photon-lib/py/docs/index.md @@ -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. diff --git a/photon-lib/py/docs/packet.md b/photon-lib/py/docs/packet.md new file mode 100644 index 000000000..50602fc62 --- /dev/null +++ b/photon-lib/py/docs/packet.md @@ -0,0 +1,3 @@ +# Packet API + +::: photonlibpy.packet diff --git a/photon-lib/py/docs/photonCamera.md b/photon-lib/py/docs/photonCamera.md new file mode 100644 index 000000000..2c1fcdd88 --- /dev/null +++ b/photon-lib/py/docs/photonCamera.md @@ -0,0 +1,3 @@ +# PhotonCamera API + +::: photonlibpy.photonCamera diff --git a/photon-lib/py/docs/photonPoseEstimator.md b/photon-lib/py/docs/photonPoseEstimator.md new file mode 100644 index 000000000..5075a84c0 --- /dev/null +++ b/photon-lib/py/docs/photonPoseEstimator.md @@ -0,0 +1,3 @@ +# Photon Pose Estimator API + +::: photonlibpy.photonPoseEstimator diff --git a/photon-lib/py/mkdocs.yml b/photon-lib/py/mkdocs.yml new file mode 100644 index 000000000..80626c158 --- /dev/null +++ b/photon-lib/py/mkdocs.yml @@ -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 +