a5136b73ad
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
19 lines
362 B
ReStructuredText
19 lines
362 B
ReStructuredText
Zuul Sphinx
|
|
===========
|
|
|
|
A Sphinx extension for documenting Zuul jobs.
|
|
|
|
Config options
|
|
--------------
|
|
|
|
``zuul_role_paths``
|
|
(str list)
|
|
List of extra paths to examine for role documentation (other than
|
|
``roles/``)
|
|
|
|
``zuul_autoroles_warn_missing``
|
|
(boolean)
|
|
Default: True
|
|
Warn when a role found with ``autoroles`` does not have a
|
|
``README.rst`` file.
|