Sphinxdoc¶

Description¶

Task is used to build Python documentation using Sphinx library.

Warning

This task requires that the installation of Python and that it can be called from the command line.

Warning

This task requires that the installation of the Python’s package sphinx.

Attribute	Description	Required
dir	Directory containing the source code of the documentation. It must contains a `conf.py` file.	yes
todir	Directory to store the created documentation.	yes
builder	Sphinx builder to use (e.g. html, latex, man, etc.)	no, defaults to html

To build a LaTeX documentation where the Sphinx files are stored in ${src.doc.dir}:

<sphinxdoc dir="${src.doc.dir}" todir="${build.doc.dir}" builder="latex" />

This task is equivalent to executing the following command:

sphinx-build -b latex ${src.doc.dir} ${build.doc.dir}