opendev/gear
Code Issues Proposed changes

Update gear docs to include gearman server daemon

Browse Source 
Use the sphinxcontrib-programoutput package to
document command line interface for geard.

Change-Id: Ibe53e9cd176e4cdacd1519c7f1da890002a67125
This commit is contained in:
Khai Do 2013-08-27 11:26:00 -07:00
parent 59d4be6ca9
commit cc6e90181e
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -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']

6
doc/source/index.rst
View File

@ -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
^^^^^^^^^^^^^^

1
test-requirements.txt
View File

@ -8,3 +8,4 @@ testrepository>=0.0.13
testresources
testscenarios
testtools>=0.9.27
sphinxcontrib-programoutput