photonvision icon indicating copy to clipboard operation
photonvision copied to clipboard

Add documentation for python

Open samfreund opened this issue 9 months ago • 3 comments

Description

This adds docs for python. The docs can be seen at https://pydocs.photonvision.org/

This is accomplished using mkdocs to scan the code and auto-generate documentation.

Meta

Merge checklist:

  • [x] Pull Request title is short, imperative summary of proposed changes
  • [x] The description documents the what and why
  • [x] If this PR changes behavior or adds a feature, user documentation is updated
  • [x] If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly
  • [x] If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1
  • [x] If this PR addresses a bug, a regression test for it is added

samfreund avatar Apr 13 '25 03:04 samfreund

Fix search so it doesn't show code

samfreund avatar Apr 13 '25 15:04 samfreund

@mcm001 How important is fixing the search anyways? I can try changing the way I'm doing the docs, cause I think that's gonna be necessary, but if we don't care that much we can just merge this.

Reasoning is that I don't see people referencing the docs on mobile that much, if they're using them they'll likely have a computer too.

samfreund avatar Apr 14 '25 01:04 samfreund

Figure out the :param

samfreund avatar Apr 14 '25 05:04 samfreund