Skip to content

Add documentation for python #1887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 59 commits into
base: main
Choose a base branch
from
Open

Add documentation for python #1887

wants to merge 59 commits into from

Conversation

samfreund
Copy link
Member

@samfreund samfreund commented Apr 13, 2025

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:

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

@samfreund samfreund requested a review from a team as a code owner April 13, 2025 03:48
@samfreund

This comment was marked as outdated.

@samfreund samfreund requested a review from mcm001 May 8, 2025 23:36
mcm001
mcm001 previously approved these changes May 9, 2025
@samfreund samfreund enabled auto-merge (squash) May 9, 2025 04:37
Copy link
Contributor

@Gold856 Gold856 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The param and return tags are still rendered as plain text

This is happening because mkdocs doesn't support reST style tags, which means we might want to switch to Sphinx - Sam

@Gold856 Gold856 disabled auto-merge May 9, 2025 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything relating to https://docs.photonvision.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants