5bc7086580
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
62 lines
947 B
ReStructuredText
62 lines
947 B
ReStructuredText
Configuration Attributes
|
|
------------------------
|
|
|
|
.. attr:: example-attr
|
|
:required:
|
|
|
|
This is an example configuration attribute.
|
|
|
|
.. attr:: foo
|
|
:default: bar
|
|
:example: sample_value_for_example_attr
|
|
:type: str
|
|
|
|
A sub attribute.
|
|
|
|
.. value:: bar
|
|
|
|
An attribute value.
|
|
|
|
.. value:: baz
|
|
|
|
Another attribute value.
|
|
|
|
.. attr:: moo
|
|
|
|
An even further nested attribute
|
|
|
|
.. attr:: boo
|
|
|
|
And one more for good luck
|
|
|
|
.. attr:: another-example-attr
|
|
|
|
And back to the top level
|
|
|
|
References
|
|
==========
|
|
|
|
This is an attribute role: :attr:`example-attr.foo`
|
|
|
|
This is an attribute value role: :value:`example-attr.foo.bar`
|
|
|
|
Summaries
|
|
=========
|
|
|
|
All attributes
|
|
^^^^^^^^^^^^^^
|
|
|
|
.. attr-overview::
|
|
|
|
Only one level
|
|
^^^^^^^^^^^^^^
|
|
|
|
.. attr-overview::
|
|
:maxdepth: 1
|
|
|
|
Only example-attr.foo prefix
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. attr-overview::
|
|
:prefix: example-attr.foo
|