zuul-sphinx/doc/source/examples.rst
James E. Blair 27322342f2 Import directives/roles from zuul
This imports the current directives from Zuul itself, and adds
an example doc page that exercises them all so this repo is more
self-testing.

Also, use python3 by default to ensure we remain py3 compat.

Change-Id: Ie5b3cedd5e8dfaf0763d09a901fc9ba0e5b63683
2017-08-07 16:45:27 -07:00

1.9 KiB

Examples

Jobs

example-job

This is an example job.

foo

This is a variable used by this job.

bar

This is a sub key.

items

This variable is a list.

baz

This is an item in a list.

example-job

This is a variant of example-job which runs on stable branches.

This is a job role: example-job

This is a job variable role: example-job.foo.bar

Roles

This is an (Ansible) role (Sphinx) role: example-role

This is an (Ansible) role variable (Sphinx) role: example-role.items.baz

Configuration Attributes

example-attr

This is an example configuration attribute.

foo

A sub attribute.

bar

An attribute value.

baz

Another attribute value.

This is an attribute role: example-attr.foo

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

Job Variables

example-variable

This is an example variable.

foo

This is a variable.

bar

This is a sub key.

items

This variable is a list.

baz

This is an item in a list.

This is a variable role: example-variable.items.baz

Statistics

example-stat

This is an example statistic.

foo

A sub stat.

This is a statistics role: example-stat.foo