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.
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
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.
Add a new option to provide an additional list of directories to look
for roles to document.
Additionally, allow the 'roles/' top-level directory to not exist.