jenkins-job-builder/doc/source
Antoine Musso 5f96ad465b Use venv to build documentation
The Sphinx documentation now make use of the `program-output` plugin
which would invoke commands to generate inline documentation. Ex:

    program-output:: zuul --help
    program-output:: zuul enqueue --help

We want the resulting output to correspond to Zuul source code, not the
command which is currently installed on the host running the doc.  On my
setup sphinx would die out because it cant find the command 'zuul'.

The new tox environement 'doc' runs sphinx in a virtual env which will
have the proper zuul command.

The generated doc is not written under the /.tox directory but to
/doc/build/html for convenience.

Example usage:

    tox -edoc && open doc/build/html/index.html

Change-Id: Ib0170f94bb2c09eb60e555a32e101e2e0959b18e
2014-03-02 10:56:40 +01:00
..
builders.rst Add documentation. 2012-09-17 20:25:38 +00:00
conf.py Add usage info to JJB documentation 2013-09-09 15:14:18 -07:00
configuration.rst Enhance project specific parameters example. 2014-02-06 21:41:33 +01:00
extending.rst Make reuse of builders/publishers inside other components easier. 2013-04-24 17:50:32 +00:00
general.rst Add display-name job property. 2013-11-05 19:04:54 -08:00
hipchat.rst Adding hipchat notification capability. 2012-10-01 17:03:26 +00:00
index.rst Add documentation. 2012-09-17 20:25:38 +00:00
installation.rst Use venv to build documentation 2014-03-02 10:56:40 +01:00
metadata.rst Metadata plugin module - largely based on Parameters module. 2013-07-08 19:17:27 +00:00
notifications.rst Add documentation. 2012-09-17 20:25:38 +00:00
parameters.rst Add documentation. 2012-09-17 20:25:38 +00:00
project_flow.rst Flow project support 2013-10-04 14:30:02 -04:00
project_freestyle.rst Add documentation. 2012-09-17 20:25:38 +00:00
project_matrix.rst add matrix job support 2012-12-06 21:09:26 +00:00
project_maven.rst Add documentation. 2012-09-17 20:25:38 +00:00
properties.rst Add documentation. 2012-09-17 20:25:38 +00:00
publishers.rst Add documentation. 2012-09-17 20:25:38 +00:00
reporters.rst Add email publisher/reporter. 2012-09-20 15:20:45 +00:00
scm.rst Add documentation. 2012-09-17 20:25:38 +00:00
triggers.rst Add documentation. 2012-09-17 20:25:38 +00:00
wrappers.rst Add documentation. 2012-09-17 20:25:38 +00:00
zuul.rst Add documentation. 2012-09-17 20:25:38 +00:00