1f8c473765
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
36 lines
1.1 KiB
YAML
36 lines
1.1 KiB
YAML
# TODO(mordred) Make this a list of known binary depends that sphinx needs
|
|
- name: Install gettext package
|
|
package:
|
|
name: gettext
|
|
state: present
|
|
become: yes
|
|
|
|
- name: Find Constraints File
|
|
include_role:
|
|
name: find-constraints
|
|
|
|
# Note (dmsimard): This installs doc/requirements.txt or test-requirements.txt
|
|
# if the former is not found. If neither are found, this task is skipped.
|
|
# TODO(dmsimard) Don't assume virtualenv is installed
|
|
- name: Initialize virtual environment
|
|
pip:
|
|
requirements: "{{ item }}"
|
|
chdir: "{{ zuul_work_dir }}"
|
|
virtualenv: "{{ zuul_work_virtualenv }}"
|
|
virtualenv_python: "{{ sphinx_python }}"
|
|
extra_args: "{{ upper_constraints | default(omit) }}"
|
|
with_first_found:
|
|
- files:
|
|
- "{{ zuul_work_dir }}/doc/requirements.txt"
|
|
- "{{ zuul_work_dir }}/test-requirements.txt"
|
|
skip: true
|
|
|
|
- name: Install doc building packages
|
|
pip:
|
|
name: "{{ item }}"
|
|
chdir: "{{ zuul_work_dir }}"
|
|
virtualenv: "{{ zuul_work_virtualenv }}"
|
|
virtualenv_python: "{{ sphinx_python }}"
|
|
extra_args: "{{ upper_constraints | default(omit) }}"
|
|
with_items: "{{ doc_building_packages }}"
|