onecodex / finch-rs

A genomic minhashing implementation in Rust
https://www.onecodex.com
MIT License
92 stars 8 forks source link

Generate python documentation #40

Open bovee opened 4 years ago

bovee commented 4 years ago

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?