zuul-sphinx/doc/source/example-autodoc.rst
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

18 lines
168 B
ReStructuredText

Auto Doc
========
Auto Jobs
---------
.. autojobs::
Auto Project Templates
----------------------
.. autoproject_templates::
Auto Roles
----------
.. autoroles::