zuul/zuul-sphinx
Code Issues Proposed changes
Sphinx extension for Zuul jobs
27 Commits 1 Branch 19 Tags 384 KiB
Python 100%
8f1cecfd74
Go to file
James E. Blair 8f1cecfd74 Ignore non-directory entries in roles/ 
The check for whether a README.rst exists would naively look for
files like __init__.py/README.rst if there were files in the roles/
directory.  Only look for role directories instead.

Change-Id: I80268047a08b1294ccef841cd59894ec7133d16d
2018-09-05 10:18:18 -07:00
doc/source Warn when autoroles doesn't find a README.rst 2018-08-24 14:09:22 +10:00
tests/roles Ignore non-directory entries in roles/ 2018-09-05 10:18:18 -07:00
zuul_sphinx Ignore non-directory entries in roles/ 2018-09-05 10:18:18 -07: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.