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

Improve documentation #66

Open
gadamc opened this issue Nov 16, 2022 · 1 comment
Open

Improve documentation #66

gadamc opened this issue Nov 16, 2022 · 1 comment

Comments

@gadamc
Copy link
Collaborator

gadamc commented Nov 16, 2022

Setup auto documentation creation with sphinx: https://www.sphinx-doc.org/en/master/

@gadamc
Copy link
Collaborator Author

gadamc commented Mar 2, 2023

Open to alternative ways to generate documentation, however. Sphinx requires writing in resturcturedTxt format, which is just one more thing to learn. Consider pdoc or pydoc. Ideally, would be able to publish on readthedocs, but that's probably not necessary as long as there's a way to render the output.

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