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

Documentation/readthedocs #2

Open
arokem opened this issue May 28, 2015 · 3 comments
Open

Documentation/readthedocs #2

arokem opened this issue May 28, 2015 · 3 comments

Comments

@arokem
Copy link
Contributor

arokem commented May 28, 2015

Several issues are outstanding, if we are to use RTD as a documentation hosting service:

What is the best way to create documentation of the API?

This is currently using scripts that I cribbed from nipy projects, and then ported to be compatible with python 3. These scripts require having the software installed on the machine, and are triggered upon running a make html. RTD uses sphinx-build directly (I think), so it's not obvious how this would patch into the process

Latex in documentation

Building documentation with latex on RTD seems to be a no-go, because their system doesn't seem to be able to build/install PIL, which is required. See here: https://readthedocs.org/builds/shablona/2882654/

@arokem
Copy link
Contributor Author

arokem commented May 28, 2015

As pointed out by @rbiswas4, other projects do use RTD, and have API reference machinery set up:

http://sncosmo.readthedocs.org/en/v1.0.x/reference.html

so there must be some way of doing that.

@andim
Copy link
Contributor

andim commented Mar 31, 2016

See my comment on #26 for a way to create api reference using read the docs. In short you can execute your build script directly from conf.py (andim/noisyopt@13541ac).

@crypdick
Copy link

+1!

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

No branches or pull requests

3 participants