Document zuul client
Adds programoutput sphinx extension as a test dependency so doc
builds can include the program help text.
Change-Id: Iec2f09f710162614cbb393a5628204ddebe2e29f
diff --git a/doc/source/client.rst b/doc/source/client.rst
new file mode 100644
index 0000000..f0b784a
--- /dev/null
+++ b/doc/source/client.rst
@@ -0,0 +1,31 @@
+:title: Zuul Client
+
+Zuul Client
+===========
+
+Zuul includes a simple command line client that may be used by
+administrators to affect Zuul's behavior while running. It must be
+run on a host that has access to the Gearman server (e.g., locally on
+the Zuul host).
+
+Configuration
+-------------
+
+The client uses the same zuul.conf file as the server, and will look
+for it in the same locations if not specified on the command line.
+
+Usage
+-----
+The general options that apply to all subcommands are:
+
+.. program-output:: zuul --help
+
+The following subcommands are supported:
+
+Enqueue
+^^^^^^^
+.. program-output:: zuul enqueue --help
+
+Example::
+
+ zuul enqueue --trigger gerrit --pipeline check --project example_project --change 12345 --patchset 1
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 422f03c..9e0d2c7 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -25,7 +25,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = [ 'sphinxcontrib.blockdiag' ]
+extensions = [ 'sphinxcontrib.blockdiag', 'sphinxcontrib.programoutput' ]
#extensions = ['sphinx.ext.intersphinx']
#intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e75e417..4b7b4b0 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -23,6 +23,7 @@
launchers
reporters
zuul
+ client
statsd
Indices and tables