This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.
See the python3-first goal document for details:
build-openstack-sphinx-docs jobs fail on stable branches due to the new
pip version 10 introduces some previously Warning as Error: in case of
calling "pip install" without any package name, the command fails.
tox_install.sh is called during docs job without any package passed to pip.
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5 .
the rename to neutronclient has been some time ago already. Also
the link was pointing to swift instead, which seems like an obvious
When subprocess is monkey-patched using eventlet, trying to catch
subprocess.CalledProcessError exception won't work . This breaks
doc build from a tarball, so let's catch all exceptions.
Since pbr already landed and the old version of hacking seems not
work very well with pbr>=2, we should update it to match global
Amended developer documentation side navigation to add an option for
clearly returning to the project developer documentation home page.
Previously it was possible to return to the home page by clicking
'table of contents' however this is not obvious and makes it hard
to get around the complete project documentation once you have left
This patch removes the link from 'table of contents' which is
misleading, and a link is added beneath this header to say 'Return
to project home page'.
Based on the branding guidelines linked in this patch, projects that are
not officially under governance should not use the theme in most
Signed-off-by: Doug Hellmann <email@example.com>
Adding constraints support to libraries is slightly more complex than
services as the libraries themselves are listed in upper-constraints.txt
which leads to errors that you can't install a specific version and a
This change adds constraints support by also adding a helper script to
edit the constraints to remove oslosphinx.
Sphinx supports various notice blocks but the oslosphinx theme
does support only warning and note. openstackdoctheme used by
openstack-manuals project supports 'important', 'tip' and 'caution'
blocks. It would be nice if oslosphinx support these notices.
It reduces confusions on contributors to both types of projects.
When git cmd fails, raw_version_list is set to empty 'str' and then
we are trying to decode it. This patch moves decoding inside try/catch
block, so we are decoding return value of subprocess call, which is bytes
in Python 3.
Adds a new option that allows the "Other Versions" section to be removed
if a project isn't interested in showing links to older versions. The
default value is False which means that it will be hidden.
Even though the setting is not backward compatible there are enough
broken documentation links in the OpenStack projects that this should be
Make the first one link to the current docs and the others
link with the appropriate prefix.
Filtered out previous versions that include "rc".
The number of versions is kept at 5 (current + 4 recent).
The last five tags (that start with a number) are used as version
numbers and linked to. This updates the sphinx extension so that
every user of the theme gets this info automatically with no need
to update the conf.py on a per-project basis.