zuul-sphinx/README.rst
Ian Wienand 06eadf8e73 Add config option to find other roles
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.

Needed-By: https://review.openstack.org/593478
Change-Id: I997c8bbece4917fe041aa9fd3dde13ee532fa2a6
2018-08-20 14:42:17 +10:00

13 lines
217 B
ReStructuredText

Zuul Sphinx
===========
A Sphinx extension for documenting Zuul jobs.
Config options
--------------
``zuul_role_path``
(str list)
List of extra paths to examine for role documentation (other than
``roles/``)