zuul/zuul-sphinx
Code Issues Proposed changes
6a29830441
zuul-sphinx/doc/source/index.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

917 B
Raw Blame History

Overview

This documentation has full examples of how to use the zuul-sphinx features.

Config options

The following options can be set

zuul_role_paths

List of extra paths to examine for role documentation (other than roles/)

zuul_roles_warn_missing

Warn when a role found with autoroles does not have a README.rst file.

Examples

Note

To see the commands that produces the rendered output for this page or any of the examples below, use the Show Source link at the bottom of the page.

example-variables example-attributes example-jobs example-templates example-roles example-autodoc example-statistics

Indices and tables

  • genindex
  • search