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

Add documentation using Sphinx-apidoc and Read The Docs for automated docs #15

Open
sword134 opened this issue Feb 28, 2025 · 0 comments

Comments

@sword134
Copy link

Hello,

I've stumbled upon this package and made a local clone on which I am sucessfully running sphinx for documentation purposes. The package already has extensive docstrings for each class and function.

It takes a few minutes to get the hang of and setup, but i'd say its well worth it and would allow for a new users to get involved with the package and potentially open pull requests in the future.

For online hosting via Read the docs: https://docs.readthedocs.com/platform/stable/tutorial/index.html
Sphinx docs auto generation: https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html

Full walkthrough tutorial: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/install.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