3.1.7. Sphinx
The tool is located in tools/waf-tools.
3.1.7.1. Tool Documentation
Implements a waf tool to use Sphinx.
- f_sphinx_build.configure(conf: waflib.Configure.ConfigurationContext)
Check that sphinx-build and dot are available
- class f_sphinx_build.sphinx_task(*args: Any, **kwargs: Any)
Bases:
Taskclass to compile a conf.py file into documentation using Sphinx.
![digraph ASM_TO_OBJECT {
compound=true;
rankdir=LR;
nd_sphinx [label="sphinx_build", style=filled, fillcolor=green];
nd_conf_py [label="conf.py", style=filled];
nd_out_dir [label="OUTDIR/index.html", style=filled];
subgraph cluster_cmd {
label = "Command Line";
rank=same;
nd_builder_name [label="BUILDERNAME"];
nd_version [label="VERSION"];
nd_release [label="RELEASE"];
nd_dot [label="DOT"];
nd_doctreedir [label="DOCTREEDIR"];
nd_srcdir [label="SRCDIR"];
}
nd_sphinx -> nd_builder_name [lhead=cluster_cmd];
nd_conf_py -> nd_builder_name [lhead=cluster_cmd];
nd_builder_name -> nd_out_dir [ltail=cluster_cmd];
}](../../_images/graphviz-6ea2a3d27863c9eb10d66830b8abc5b5df8fd6d8.png)
Fig. 3.16 Input-output relation for conf.py
- always_run = True
Sphinx handles the need for a re-run, so always run this task
- Type:
str
- color = 'BLUE'
color in which the command line is displayed in the terminal
- Type:
str
- keyword()
displayed keyword when the sphinx configuration file is compiled
