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.

Sign up for GitHub

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

Jump to bottom

Docs should be generated from code + docstrings. #47

Open
johnsca opened this issue Feb 8, 2022 · 1 comment
Open

Docs should be generated from code + docstrings. #47

johnsca opened this issue Feb 8, 2022 · 1 comment

Comments

@johnsca
Copy link
Contributor

johnsca commented Feb 8, 2022

Currently, docs/reference.md has to be manually maintained and thus has a significant possibility of falling out of sync with the actual set of helpers which are available.
@heitorPB
Copy link

I was looking into this project and the documentation is quite hard to read.

Any chance to use Sphinx to generate the docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@johnsca @heitorPB