3.1.33. waf_tools.sphinx_build

Implements a waf tool to use Sphinx.

Functions

apply_sphinx(self)

Set up the task generator with a Sphinx instance and create a task.

configure(ctx)

Find 'sphinx-build' executable.

find_sphinx_build(ctx)

Find the 'sphinx-build' executable and determine its version.

get_sphinx_build_version(ctx)

Determine 'sphinx-build' version

Classes

CleanDocs(**kw)

Custom clean command that removes generated documentation artifacts.

create_version_file(*k, **kw)

Create a version macro replacement file for Sphinx.

sphinx_task(*k, **kw)

Render rst-source files through a conf.py configuration file