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
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
Ian Wienand