diff options
| author | Khai Do <zaro0508@gmail.com> | 2013-08-27 11:26:00 -0700 |
|---|---|---|
| committer | Khai Do <zaro0508@gmail.com> | 2013-08-30 21:07:57 -0700 |
| commit | cc6e90181eb63f32757430bfcfa0a3dc4c91ac47 (patch) | |
| tree | ac90f3c88a7ceb17ff09b4fbaf42abe694ebe001 /doc | |
| parent | 59d4be6ca9220807290f4e5023e830dd0c9582b6 (diff) | |
| download | gear-cc6e90181eb63f32757430bfcfa0a3dc4c91ac47.tar.gz | |
Update gear docs to include gearman server daemon
Use the sphinxcontrib-programoutput package to
document command line interface for geard.
Change-Id: Ibe53e9cd176e4cdacd1519c7f1da890002a67125
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 6 |
2 files changed, 3 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 9eac01e..7816277 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,7 +26,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 = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinxcontrib.programoutput'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/source/index.rst b/doc/source/index.rst index 9d181fc..5b62114 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -55,7 +55,7 @@ An example of a Gearman worker:: while True: job = worker.getJob() - job.sendWorkComplete(job.arguments.reverse()) + job.sendWorkComplete(job.arguments[::-1]) SSL Connections --------------- @@ -156,10 +156,8 @@ AdminRequest Objects Server Usage ------------ +.. program-output:: geard --help -A simple Gearman server is provided for convenience in unit testing, -but is not designed for production use at scale. It takes no -parameters other than the port number on which to listen. Server Objects ^^^^^^^^^^^^^^ |