zuul-jobs/roles/install-if-python
David Moreau Simard 1f8c473765
Add sphinx_python variable to sphinx role and job
Some projects, such as Zuul itself, need to use python3 to build docs.

This adds a new parameter, sphinx_python, which defines the version
of python to build documentation with. The default is python2 and
projects can choose python3 on a need basis.

Remove the comment about the need for a leading comment, since there
is now a real need for the leading comment anyway.

Replace a few direct references to {{ ansible_user_dir }}/.venv that
should have been using zuul_work_virtualenv.

Update sphinx invocation to source the virtualenv activate first.
Some sphinx modules, such as sphinxcontrib.programoutput, attempt to
execute programs and only invoking sphinx-build with the relative
path causes the paths to not be set up properly.

Co-Authored-By: David Moreau Simard <dmsimard@redhat.com>
Change-Id: Ie5e2c93f88465f4aa746827ff88a585dbaa44fd5
2017-12-05 21:10:15 -05:00
..
defaults Add general sphinx and reno jobs and role 2017-11-20 17:59:28 -06:00
tasks Add sphinx_python variable to sphinx role and job 2017-12-05 21:10:15 -05:00
README.rst Add general sphinx and reno jobs and role 2017-11-20 17:59:28 -06:00

Install the contents of a directory if they contain a python project.

Installs into a virtualenv.

Role Variables

Flag that indicates installation errors should result in failure. Failures in installing the target directory are ignored by default.

Optional path to a pip constraints file to use when installing.