zuul-sphinx/doc/source
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
..
_static Add logo to docs 2018-05-04 14:52:18 -07:00
zuul.d Fix error in job parser 2017-10-18 15:56:21 -07:00
conf.py Warn when autoroles doesn't find a README.rst 2018-08-24 14:09:22 +10:00
example-autodoc.rst Warn when autoroles doesn't find a README.rst 2018-08-24 14:09:22 +10:00
example-jobs.rst Add jobvar and rolevar directives 2017-08-11 15:04:23 -07:00
example-roles.rst Add jobvar and rolevar directives 2017-08-11 15:04:23 -07:00
example-templates.rst Add support for project-templates 2017-10-16 16:45:54 -07:00
examples.rst Add jobvar and rolevar directives 2017-08-11 15:04:23 -07:00
index.rst Add support for project-templates 2017-10-16 16:45:54 -07:00