The trademark for the logo, as filed, is specified as dark blue.
That logo needs to be displayed in a user guide or manual or
alongside a direct download of the software in order to demonstrate
continued use of the mark, and the foundation's trademark lawyers
have expressed concern that a white version is insufficient (but
they seem to be okay with the current background color as long as
the lines of the logo are colored similar to the version on file).
This is a copy of the equivalent change from the zuul repository.
Co-Authored-By: James E. Blair <jim@acmegating.com>
Depends-On: https://review.opendev.org/934443
Change-Id: I5bc28f0117e26e451f77fb0946ee1de44beb6852
A variable reassignment in conf.py caused errors when we try to build
release versions of docs. Correct that by swapping the order of use
and assignment.
Change-Id: Ica90e9c0cc20aa590ad0177a0ceab72f4f4c6b5b
This brings this documentation into line with other values like attr
where you can specify the type of the variable.
The type output is added to each entry where appropriate, one minor
change is that we need to be less strict on the type lookup for
the hint suffix on sub-entries for types like "bool"
The documentation/test-case is updated.
Change-Id: Icc01ec6f04af97beeb085f6dbcf37b0d9dbed1fd
This directive creates a bullet-point list of all the attributes
defined within a file. The idea is to give a quick overview reference
for config file options.
There are two options to start with -- maxdepth is similar to the TOC
option and only shows certain levels of options; prefix allows to
filter down to a smaller set of options if required.
I've reworked the documentation examples as part of testing this. The
various components are moved into separate files. On the main page,
moved the config options into the main documentation (and use the zuul
attributes :) and pointed out that you can view the source of each
sample page to see how to generate what you see.
Change-Id: I6b0f414f50428c6e04b3aeb2a2c1f9196de80ce6
This modifies autoroles to raise a warning when it finds a role
without a README.rst file. This can be disabled with a config option
if you wish to build with warning-as-error but don't wish to document
roles.
Fix a typo in the readme for the zuul_role_paths
Add a test for the autoroles path detection by including a roles
directory under a subdir. Manually removing the README.rst file has
validated that the warning is triggered.
Change-Id: Ia64298e6e910d21eb6f3830dd8b42e40e3444fa8
Jobs and Roles frequently have the same variable names, so use
create unique directives and roles for each so that they are
easy to disambiguate.
This lets us say :jobvar:`tox.environment` rather than
:var:`job-tox.environment` which seems a bit arbitrary.
Change-Id: I9d72d11bfdb700037a6a08f92a2dbfa95ee519ad
This imports the current directives from Zuul itself, and adds
an example doc page that exercises them all so this repo is more
self-testing.
Also, use python3 by default to ensure we remain py3 compat.
Change-Id: Ie5b3cedd5e8dfaf0763d09a901fc9ba0e5b63683
Sphinx and pbr are run-time requirements of this package.
Remove dep on oslosphinx.
Tell pbr our package name.
Change-Id: Ia23cb2845b4d482888637728ac7712358e5e3629
