zuul-jobs/roles/ensure-sphinx/README.rst
Kevin Carter 167cc321f4 Update the sphinx python package sets
The role will now use a known functional set of packages based on the
version of python being defined.

To allow users to add packages to a known functional version of
sphinx the variable `doc_building_extra_packages` has been added.
This option will union with `doc_building_packages`, installing all
python packages in a single set.

The releasenotes pre playbook has been updated so that it no longer
overrides the default package set when calling the "ensure-sphinx"
role. The playbook will now use the `doc_building_extra_packages`
option and include only the additional packages it needs. This change
allows folks to rely on the role to setup sphinx correctly without
needing to overriding everything.

Change-Id: Ib3d2fda164b173c82f17fabc20814753bfeaec6e
Signed-off-by: Kevin Carter <kecarter@redhat.com>
2019-07-08 07:48:31 -07:00

40 lines
1.0 KiB
ReStructuredText

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**
.. zuul:rolevar:: constraints_file
Optional path to a pip constraints file for installing python libraries.
.. zuul:rolevar:: doc_building_packages
:default: ``list``
List of python packages to install for building docs. The default
package list is based on the python version in use.
.. zuul:rolevar:: doc_building_extra_packages
:default: ``list``
List of python additional packages to install for building docs.
By default this list is empty.
.. zuul:rolevar:: sphinx_python
:default: python2
Version of python to use, either ``python2`` or ``python3``.
.. zuul:rolevar:: zuul_work_virtualenv
:default: ~/.venv
Virtualenv location in which to install things.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
Directory to operate in.