zuul-sphinx

History

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
..
__init__.py	Add setup to module import	2017-08-04 16:02:27 -07:00
zuul.py	Add attr-overview directive	2018-09-28 20:18:28 +10:00

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

__init__.py

Add setup to module import

2017-08-04 16:02:27 -07:00

zuul.py

Add attr-overview directive

2018-09-28 20:18:28 +10:00