zuul/zuul-jobs
Code Issues Proposed changes
4a04383076
zuul-jobs/roles/sphinx
History
James E. Blair 9e22cfdb0f Remove shebang from all python ansible modules 
This commit in Ansible:
9142be2f6c

now allows Python modules to specify their interpreter with the shebang.
We expect our roles to use the discovered python interpreter on remote
nodes, and on the executor, we need them to use the virtualenv.  Removing
the specific shebang accomplishes this under Ansible 6, and has no effect
under older versions of Ansible.

Without this, for example, the log upload roles would not have access to
their cloud libraries.

Also update our ansible/cli check in our module files.  Many of our modules
can be run from the command line for ease of testing, but the check that we
perform to determine if the module is being invoked from the command line
or Ansible fails on Ansible 5.  Update it to a check that should work in
all 4 versions of Ansible that Zuul uses.

Change-Id: I4e6e85156459cca032e6c3e1d8a9284be919ccca
2022-09-15 13:48:10 -07:00
..
defaults Add general sphinx and reno jobs and role 2017-11-20 17:59:28 -06:00
library Remove shebang from all python ansible modules 2022-09-15 13:48:10 -07:00
tasks Check for loop_control in with_ type loops 2020-05-01 13:45:34 +02:00
__init__.py Enable Python 2.7 unit tests 2018-08-17 10:23:20 +10:00
README.rst Default warning-is-error to True for non-legacy Sphinx projects 2018-05-10 09:23:57 +01:00

README.rst

Run sphinx to generate documentation

Role Variables

Whether to treat sphinx build warnings as errors. Defaults to the value of [build_sphinx] warning-is-error in setup.cfg if defined, False if the [build_sphinx] section is present but the warning-is-error option is undefined, or True if the entire section is undefined.