On 04/04/2017 23:59, Siddiqui, Shahzeb wrote:
Hello,
Our team is looking at Sphinx for documentation and we are hoping to
use Readthedocs building the documentation. One feature we have is the
ability to present dynamic data using program-output which runs a
shell-script and presents the output in the document.
We are running sphinx on our local machine, my concern is will this
work when moving the project to Readthedocs. Do you have any dynamic
data in Easybuild document that is run from a script that is
system-dependent. For instance, running a command “module avail” to
present current modules in the system dynamically, will this work when
putting in Readthedocs.
We generate some documentation, but prior to pushing documentation
updates to RTD, see
https://github.com/hpcugent/easybuild/blob/master/docs/scripts/update-all-docs.sh
which updates the version-specific documentation in
https://github.com/hpcugent/easybuild/tree/master/docs/version-specific.
So, in that sense, no, we don't auto-generate stuff on the platform
where Sphinx is running, we generate it before Sphinx is run (by
readthedocs).
One exception is the API documentation, where we use the 'automodule'
feature to let Sphinx generate the documentation using the latest
EasyBuild version (which gets installed on the readthedocs platform
itself, where it generates the actual documentation).
See https://github.com/hpcugent/easybuild/tree/master/docs/api which is
updated with
https://github.com/hpcugent/easybuild/blob/master/docs/scripts/gen_api_docs.py
.
regards,
Kenneth
Regards,
Shahzeb Siddiqui
HPC Linux Engineer
B2220-447.2
Groton, CT
