jjb/jenkins-job-builder
Code Issues Proposed changes

Add usage info to JJB documentation

Browse Source 
Display the usage info for JJB and add it to the
sphinx docs.

Fixes bug 1221944

Change-Id: I5b36cca7a836b009bfb0ca880abbccd4477de307
This commit is contained in:
Khai Do 2013-09-09 10:30:01 -07:00 committed by Antoine Musso
parent 7e25cab7a0
commit d18c3cb1f5
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -27,7 +27,7 @@ sys.path.insert(0, os.path.abspath('../../jenkins_jobs/modules'))
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage',
'jenkins_jobs.sphinx.yaml'] 'jenkins_jobs.sphinx.yaml', 'sphinxcontrib.programoutput']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

12
doc/source/installation.rst
View File

@ -48,14 +48,14 @@ Running
After it's installed and configured, you can invoke Jenkins Job After it's installed and configured, you can invoke Jenkins Job
Builder by running ``jenkins-jobs``. You won't be able to do anything Builder by running ``jenkins-jobs``. You won't be able to do anything
useful just yet without a configuration which is discussed in the next useful just yet without a configuration which is discussed in the next
section). But you should be able to get help on the various commands section.
by running::
jenkins-jobs --help Usage
jenkins-jobs update --help ^^^^^
jenkins-jobs test --help .. program-output:: jenkins-jobs --help
(etc.)
Testing
^^^^^^^
Once you have a configuration defined, you can test it with:: Once you have a configuration defined, you can test it with::
jenkins-jobs test /path/to/config -o /path/to/output jenkins-jobs test /path/to/config -o /path/to/output

1
tools/test-requires
View File

@ -6,3 +6,4 @@ setuptools_git>=0.4
testscenarios testscenarios
testtools testtools
testrepository testrepository
sphinxcontrib-programoutput