zuul-sphinx/doc/source/index.rst
James E. Blair a8465c7cc1 Add :zuul:path support
This is to support documenting zookeeper paths in the Zuul developer
docs.

Change-Id: Id29eee89b38b34a3dac09750d6cabb442551e211
2021-11-11 15:06:53 -08:00

934 B

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 example-paths

Indices and tables

  • genindex
  • search