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

Generate python documentation #40

Open
bovee opened this issue Dec 3, 2019 · 0 comments
Open

Generate python documentation #40

bovee opened this issue Dec 3, 2019 · 0 comments

Comments

@bovee
Copy link
Contributor

bovee commented Dec 3, 2019 •
edited
Loading

It looks like it's possible to run pydoc against the package generated by pyo3 so we should consider trying to generate API documentation above and beyond that inside the docstrings, if possible.

Screen Shot 2019-12-03 at 11 18 29 AM

Something like sphinx or mkdocs would probably be better and we may want to publish to readthedocs also?
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bovee