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

Example Generate documentation from doc strings #62

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

manuGil
Copy link
Member

@manuGil manuGil commented Oct 28, 2024

This is an example of how to use autodoc to generate documentation from doc string for Sphinx.
Once the the PRs with doc strings are merged, we can use this as an example to add more models to the models.rst file.

The content of models.rst most be in reStructured text (Marckdown won't be always be rendered properly)
If necessary, other parts of the source code can be documented in different RST files.

@manuGil manuGil added the documentation Improvements or additions to documentation label Oct 28, 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

Successfully merging this pull request may close these issues.

1 participant