nipy / mindboggle

Automated anatomical brain label/shape analysis software (+ website)
http://mindboggle.info
Other
146 stars 54 forks source link

ReadTheDocs not generating API docs #72

Closed binarybottle closed 8 years ago

binarybottle commented 8 years ago

I would like to use readthedocs.org to provide continuous documentation for the mindboggle Github repo. I am currently able to build all the API docs locally without any errors, but when I push to the Github repo, the mindboggle.readthedocs.org Builds website tells me that the latest build has passed, but nothing shows up for py-modindex.html. (I should mention that all of my docstrings use the numpy docstring convention, so I have tried (and succeeded locally with) napoleon or numpydoc.)

binarybottle commented 8 years ago

Eric Ho of readthedocs.org wrote to me:

"Do you have the API docs checked into the repo? We don't run your Makefile, so the api_build script won't be called unless it's called via the conf.py, or checked in."

As soon as I pushed the api/*.rst files (after running "make html") all of the api docs showed up on mindboggle.readthedocs.org.

binarybottle commented 8 years ago

conf.py now runs 'bash api_build.sh' to automate API doc generation.