mirror of
https://github.com/PhotonVision/photonvision
synced 2026-06-23 01:21:40 +00:00
add docs for python
This commit is contained in:
3
photon-lib/py/docs/estimatedRobotPose.md
Normal file
3
photon-lib/py/docs/estimatedRobotPose.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# EstimatedRobotPose API
|
||||
|
||||
::: photonlibpy.estimatedRobotPose
|
||||
17
photon-lib/py/docs/index.md
Normal file
17
photon-lib/py/docs/index.md
Normal 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.
|
||||
3
photon-lib/py/docs/packet.md
Normal file
3
photon-lib/py/docs/packet.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Packet API
|
||||
|
||||
::: photonlibpy.packet
|
||||
3
photon-lib/py/docs/photonCamera.md
Normal file
3
photon-lib/py/docs/photonCamera.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# PhotonCamera API
|
||||
|
||||
::: photonlibpy.photonCamera
|
||||
3
photon-lib/py/docs/photonPoseEstimator.md
Normal file
3
photon-lib/py/docs/photonPoseEstimator.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Photon Pose Estimator API
|
||||
|
||||
::: photonlibpy.photonPoseEstimator
|
||||
18
photon-lib/py/mkdocs.yml
Normal file
18
photon-lib/py/mkdocs.yml
Normal 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
|
||||
|
||||
Reference in New Issue
Block a user