Zuul Sphinx

A Sphinx extension for documenting Zuul jobs and configuration.

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
Type: str list

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

zuul_roles_warn_missing
Default: True
Type: bool
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.

Indices and tables