zuul/zuul-sphinx
Code Issues Proposed changes
a1fdd21616
zuul-sphinx/doc/source/example-attributes.rst
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

947 B
Raw Blame History

Configuration Attributes

example-attr

This is an example configuration attribute.

foo

A sub attribute.

bar

An attribute value.

baz

Another attribute value.

moo

An even further nested attribute

boo

And one more for good luck

another-example-attr

And back to the top level

References

This is an attribute role: example-attr.foo

This is an attribute value role: example-attr.foo.bar

Summaries

All attributes

Only one level

Only example-attr.foo prefix