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

Documentation #2

Open
zonca opened this issue Aug 11, 2023 · 0 comments
Open

Documentation #2

zonca opened this issue Aug 11, 2023 · 0 comments

Comments

@zonca
Copy link
Member

zonca commented Aug 11, 2023

It is nice you have docstrings in the functions.
It would be useful to use Sphynx to automatically extract those docstrings and build documentation, see for example PySM:
https://github.com/galsci/pysm/tree/main/docs

You can configure readthedocs so that at documentation is built at every commit: https://docs.readthedocs.io/en/stable/tutorial/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant