zuul/zuul-sphinx
Code Issues Proposed changes
Sphinx extension for Zuul jobs
30 Commits 1 Branch 19 Tags 372 KiB
Python 100%
5bc7086580
Go to file
Ian Wienand 5bc7086580 Add attr-overview directive 
This directive creates a bullet-point list of all the attributes
defined within a file.  The idea is to give a quick overview reference
for config file options.

There are two options to start with -- maxdepth is similar to the TOC
option and only shows certain levels of options; prefix allows to
filter down to a smaller set of options if required.

I've reworked the documentation examples as part of testing this.  The
various components are moved into separate files.  On the main page,
moved the config options into the main documentation (and use the zuul
attributes :) and pointed out that you can view the source of each
sample page to see how to generate what you see.

Change-Id: I6b0f414f50428c6e04b3aeb2a2c1f9196de80ce6
2018-09-28 20:18:28 +10:00
doc/source Add attr-overview directive 2018-09-28 20:18:28 +10:00
tests/roles Ignore non-directory entries in roles/ 2018-09-05 10:18:18 -07:00
zuul_sphinx Add attr-overview directive 2018-09-28 20:18:28 +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 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 Add attr-overview directive 2018-09-28 20:18:28 +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 and configuration.