You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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/
The text was updated successfully, but these errors were encountered:
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).
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 usessphinx-build
directly (I think), so it's not obvious how this would patch into the processLatex 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/
The text was updated successfully, but these errors were encountered: