zuul/zuul-jobs
Code Issues Proposed changes
46389b5187
zuul-jobs/roles/ensure-sphinx
History
Monty Taylor 0dc2c9466d
Deal with lack of requirements file better 
For projects that only need sphinx and no other actual depenedencies,
there's no real value in failing if we don't find a doc requirements
file. We know all things using ensure-sphinx will, in fact, need sphinx.
Past that, it's entirely reasonable for someone to have no other needs.

Change-Id: I07dfa12f4aceee50a2f2c000df937dcbb09dd557
2017-12-18 12:25:03 -06:00
..
defaults Revert "Revert "Add sphinx_python variable to sphinx role and job"" 2017-12-13 16:31:26 +01:00
tasks Deal with lack of requirements file better 2017-12-18 12:25:03 -06:00
README.rst Revert "Revert "Add sphinx_python variable to sphinx role and job"" 2017-12-13 16:31:26 +01:00

README.rst

Ensure sphinx is installed

Installs sphinx. Also installs any dependencies needed in the first of doc/requirements.txt and test-requirements.txt to be found.

All pip installs are done with a provided constraints file, if given.

Role Variables

Optional path to a pip constraints file for installing python libraries.