diff options
| -rw-r--r-- | doc/source/client.rst | 31 | ||||
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | test-requirements.txt | 1 |
4 files changed, 34 insertions, 1 deletions
diff --git a/doc/source/client.rst b/doc/source/client.rst new file mode 100644 index 000000000..f0b784a18 --- /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 422f03c57..9e0d2c745 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,7 +25,7 @@ sys.path.insert(0, os.path.abspath('../..')) # 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 e75e4177c..4b7b4b028 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,6 +23,7 @@ Contents: launchers reporters zuul + client statsd Indices and tables diff --git a/test-requirements.txt b/test-requirements.txt index 90d4934a3..9afa8225a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,3 +9,4 @@ fixtures>=0.3.14 python-subunit testrepository>=0.0.17 testtools>=0.9.32 +sphinxcontrib-programoutput |