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

Investigate generation of documentation #30

Closed
danieldk opened this issue Jul 8, 2019 · 2 comments
Closed

Investigate generation of documentation #30

danieldk opened this issue Jul 8, 2019 · 2 comments
Assignees

Comments

@danieldk
Copy link
Member

danieldk commented Jul 8, 2019

Investigate current possibilities for documentation generation in pyo3 and pyo3-pack. Ideally, we'd generate something similar to readthedocs. This is the last item from #5.

@RealNicolasBourbaki
Copy link

RealNicolasBourbaki commented Aug 12, 2019

I have tried a few things, and it seems Sphinx is a very nice option.
we can use automodule and autoclass to build doc base on docstrings in rust.
here is an example project: https://fastobo.readthedocs.io/en/latest/
and the code is here: https://github.com/fastobo/fastobo-py/tree/master/docs

another option is generate json file based on rust docstrings, and use Sphinx to generate documentation. But it seems a bit unnecessary since automodule and autoclass can already handle docstrings very well.

The style is also Read the Docs.

@danieldk
Copy link
Member Author

Closing this issue, as it applied to the Rust version of the module.

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

No branches or pull requests

2 participants