Sphinx extension for Zuul jobs
Go to file
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
doc/source Add logo to docs 2018-05-04 14:52:18 -07:00
zuul_sphinx Add config option to find other roles 2018-08-20 14:42:17 +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 Stop publishing to docs.openstack.org 2018-07-12 11:12:28 -07:00
LICENSE Initial commit 2017-06-16 10:38:17 -07:00
README.rst Add config option to find other roles 2018-08-20 14:42:17 +10:00
bindep.txt Initial commit 2017-06-16 10:38:17 -07: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 Import directives/roles from zuul 2017-08-07 16:45:27 -07:00

README.rst

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/)