zuul-sphinx/doc/source/example-paths.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

33 lines
549 B
ReStructuredText

ZooKeeper Paths
---------------
.. path:: zuul
This is an example Zookeeper path
.. path:: zuul/tenant
A sub path. Since paths can get quite long, you may choose to
indent or to specify the full path. The signature will appear the
same either way.
.. path:: <bar>
:ephemeral:
Another sub path.
.. path:: lock
:type: RLock
:ephemeral:
Another sub path.
.. path:: zuul-system
Another top level path.
References
==========
This is a path role: :path:`zuul/tenant/<bar>/lock`