Sphinx is the Python Documentation Generator. It uses RestructuredText as input format.
The :bbSphinx
step will run sphinx-build
or any other program specified in its sphinx
argument and count the various warnings and error it detects.
from buildbot.plugins import steps
f.addStep(steps.Sphinx(sphinx_builddir="_build"))
This step takes the following arguments:
sphinx_builddir
(required) Name of the directory where the documentation will be generated.
sphinx_sourcedir
(optional, defaulting to
.
), Name the directory where theconf.py
file will be foundsphinx_builder
(optional) Indicates the builder to use.
sphinx
(optional, defaulting to
sphinx-build
) Indicates the executable to run.tags
(optional) List of
tags
to pass tosphinx-build
defines
(optional) Dictionary of defines to overwrite values of the
conf.py
file.strict_warnings
(optional) Boolean, defaults to False. Treat all warnings as errors.
mode
(optional) String, one of
full
orincremental
(the default). If set tofull
, indicates to Sphinx to rebuild everything without re-using the previous build results.