Hi Ken, So it seems like you are using shell commands to append "rst commands" into .rst files which makes sphinx generate the commands. This is nice trick.
I will give this a shot. Thanks From: easybuild-requ...@lists.ugent.be [mailto:easybuild-requ...@lists.ugent.be] On Behalf Of Kenneth Hoste Sent: Thursday, April 6, 2017 6:12 AM To: easybuild@lists.ugent.be Subject: Re: [easybuild] Readthedocs EasyBuild dynamic data (program-output) 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<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_hpcugent_easybuild_blob_master_docs_scripts_update-2Dall-2Ddocs.sh&d=DwMD-g&c=UE1eNsedaKncO0Yl_u8bfw&r=RMJdCm7m5fiPWhajwKUnEW5yn4eK2YdUWW-MLVShghg&m=Rbpm98sV8qU9AR8g_KY6uz84ljeD0H3UFdtb_9Equw0&s=Ruq_XePMoWmqA_1xLuBAUDsUqunSM1c2CseYB-yC6-I&e=> which updates the version-specific documentation in https://github.com/hpcugent/easybuild/tree/master/docs/version-specific<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_hpcugent_easybuild_tree_master_docs_version-2Dspecific&d=DwMD-g&c=UE1eNsedaKncO0Yl_u8bfw&r=RMJdCm7m5fiPWhajwKUnEW5yn4eK2YdUWW-MLVShghg&m=Rbpm98sV8qU9AR8g_KY6uz84ljeD0H3UFdtb_9Equw0&s=QgoLgYLiaAmFVFTBBy-vclmepgvOgrljLsbiZt-1GVk&e=>. 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<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_hpcugent_easybuild_tree_master_docs_api&d=DwMD-g&c=UE1eNsedaKncO0Yl_u8bfw&r=RMJdCm7m5fiPWhajwKUnEW5yn4eK2YdUWW-MLVShghg&m=Rbpm98sV8qU9AR8g_KY6uz84ljeD0H3UFdtb_9Equw0&s=u9heukoUg-MB24PP97wxyXfI9YQV25UqTrjI82oFtl0&e=> which is updated with https://github.com/hpcugent/easybuild/blob/master/docs/scripts/gen_api_docs.py<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_hpcugent_easybuild_blob_master_docs_scripts_gen-5Fapi-5Fdocs.py&d=DwMD-g&c=UE1eNsedaKncO0Yl_u8bfw&r=RMJdCm7m5fiPWhajwKUnEW5yn4eK2YdUWW-MLVShghg&m=Rbpm98sV8qU9AR8g_KY6uz84ljeD0H3UFdtb_9Equw0&s=HKybo_EaiHQU_MZRMY_d-W-18mSnO_1Egp6sk-PLFog&e=> . regards, Kenneth Regards, Shahzeb Siddiqui HPC Linux Engineer B2220-447.2 Groton, CT
