-1

We have a set of Ansible modules on GitHub (https://github.com/zhmcclient/zhmc-ansible-modules) and can generate HTML documentation from it using Sphinx. However, the build process includes a step where a documentationgenerator tool from Ansible is run to generate .rst files from the Python module source.

We have set up an RTD project for this (http://zhmc-ansible-modules.readthedocs.io/), but that extra step is not run there, of course.

-> How can we get that extra step run within the build process that runs on RTD?

mzjn
  • 48,958
  • 13
  • 128
  • 248
Andreas Maier
  • 2,724
  • 1
  • 26
  • 30

1 Answers1

1

RTD does not support intermediary steps in its build process. You must provide source files in your repository that are ready to be rendered. See RTD Build Process.

Steve Piercy
  • 13,693
  • 1
  • 44
  • 57
  • Thanks for the answer. I was afraid of that being the case ... Our solution is now to check in the generated .rst files for the Ansible modules, and to have a check in the Travis CI run as to whether these .rst files are up to date w.r.t. the module source files. – Andreas Maier Jul 21 '17 at 11:03