Skip to content
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

Generate Pydoc for app classes and add to repo #3

Open
Angelina-C opened this issue Jun 19, 2024 · 0 comments
Open

Generate Pydoc for app classes and add to repo #3

Angelina-C opened this issue Jun 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Angelina-C
Copy link
Collaborator

Pydoc can be generated with the pydoc command: python -m pydoc <file>. It will list all methods in a class and the corresponding documentation, and supports various file formats. This is a good addition to the app READMEs.

The Pydoc should be generated in the release pipeline, and committed. Decide on if we want to do this on an RC branch, or that we commit it directly to main.

@Angelina-C Angelina-C added the documentation Improvements or additions to documentation label Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant