Commit Graph

15 Commits

Author SHA1 Message Date
James E. Blair 6acbcbb2f9 Correct tagged version docs build
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
2022-03-21 10:28:29 -07:00
James E. Blair 202ca394fb Switch docs theme to versioned RTD
To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul.

Change-Id: Ic23dcbc743ca1c79bcead8eebd2899c00e0750c6
2021-12-16 11:23:09 -08:00
James E. Blair a8465c7cc1 Add :zuul:path support
This is to support documenting zookeeper paths in the Zuul developer
docs.

Change-Id: Id29eee89b38b34a3dac09750d6cabb442551e211
2021-11-11 15:06:53 -08:00
Ian Wienand 6a0034ebca Add type to role variables
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
2019-03-11 16:53:37 +11:00
Ian Wienand 5bc7086580 Add attr-overview directive
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
2018-09-28 20:18:28 +10:00
Ian Wienand 0210c9df03 Add example and type options to attributes
As described; this is used in the nodepool configuration
documentation.

Change-Id: Iad188fd69818762cc9bad927beaff55749e0385c
2018-09-26 07:34:17 +10:00
Ian Wienand a5136b73ad Warn when autoroles doesn't find a README.rst
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
2018-08-24 14:09:22 +10:00
James E. Blair 064feaa430 Add logo to docs
Change-Id: Id99b12f30c39eeaabf4696555c92ee4fae3a2f82
2018-05-04 14:52:18 -07:00
James E. Blair aa62ecad86 Fix error in job parser
Change-Id: Id806d3648ad7464a2e6d1ae1235061f48014a49a
2017-10-18 15:56:21 -07:00
James E. Blair 4122b0b8f0 Add support for project-templates
Change-Id: I0f86acd7fb5e049e5368249de52f9d81a99936d8
2017-10-16 16:45:54 -07:00
James E. Blair ad1188ba7f Add jobvar and rolevar directives
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
2017-08-11 15:04:23 -07:00
James E. Blair 27322342f2 Import directives/roles from zuul
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
2017-08-07 16:45:27 -07:00
James E. Blair 553fdce0cf Change usage from zuul_sphinx.zuul to zuul_sphinx
Change-Id: I6ca81675981a653cbf403b4870550d5b9b46a793
2017-08-04 16:22:26 -07:00
James E. Blair 4eaed1f585 Fix package setup
Sphinx and pbr are run-time requirements of this package.

Remove dep on oslosphinx.

Tell pbr our package name.

Change-Id: Ia23cb2845b4d482888637728ac7712358e5e3629
2017-07-31 14:00:10 -07:00
James E. Blair 7342ef9e80 Initial commit
Copied from openstack-infra/zuul-jobs repo.

Change-Id: If76b2313dc54557d6271dbaba8d8bb555ed5eae8
2017-06-16 10:38:17 -07:00