Go to file

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

doc/source

Warn when autoroles doesn't find a README.rst

2018-08-24 14:09:22 +10:00

tests/roles/example-role

Warn when autoroles doesn't find a README.rst

2018-08-24 14:09:22 +10:00

zuul_sphinx

Warn when autoroles doesn't find a README.rst

2018-08-24 14:09:22 +10:00

.gitignore

Fix package setup

2017-07-31 14:00:10 -07:00

.gitreview

Added .gitreview

2017-06-14 13:18:31 +00:00

.zuul.yaml

Update docs build job

2018-08-21 21:08:23 +02:00

bindep.txt

Initial commit

2017-06-16 10:38:17 -07:00

LICENSE

Initial commit

2017-06-16 10:38:17 -07:00

README.rst

Warn when autoroles doesn't find a README.rst

2018-08-24 14:09:22 +10:00

requirements.txt

Remove cap on sphinx

2017-07-31 16:12:22 -07:00

setup.cfg

Mark zuul-sphinx as supporting python3

2017-08-09 11:57:03 -05:00

setup.py

Initial commit

2017-06-16 10:38:17 -07:00

test-requirements.txt

Fix package setup

2017-07-31 14:00:10 -07:00

tox.ini

Update docs build job

2018-08-21 21:08:23 +02:00

README.rst

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.