Add documentation to readthedocs

openvax / pyensembl

Python interface to access reference genome features (such as genes, transcripts, and exons) from Ensembl

Apache License 2.0

374 stars 65 forks source link

Add documentation to readthedocs #143

Open hammer opened 8 years ago

hammer commented 8 years ago

Some tips at https://codeandchaos.wordpress.com/2012/07/30/sphinx-autodoc-tutorial-for-dummies

What I did:

Install sphinx
Make docs/ and run the quickstart
Run sphinx-apidoc from project root and send output to docs/
Edit conf.py to look in project root index.rst to include modules

hammer commented 8 years ago

@iskandr @armish can one of y'all add me as an owner for the project? I'm jeff.hammerbacher on RTD.

hammer commented 8 years ago

Current RTD builds (e.g. https://readthedocs.org/projects/pyensembl/builds/3852559/) are failing because installing our dependencies takes too long; cf. https://github.com/rtfd/readthedocs.org/issues/1767.

armish commented 8 years ago

Just added you as an admin to the project :+1:

iskandr commented 8 years ago

@hammer I think it's also failing because of dependencies on C extensions.

ivirshup commented 2 years ago

Would be really great if this could be implemented! This package could be quite useful to some projects I'm working on, but it's little difficult to figure out what functionality it provides.

I think build times for this package and readthedocs tooling have both improved considerably since this issue was raised. Happy to help if there's any way I can.