3.1.15. Sphinx
The tool is located in tools/waf-tools.
3.1.15.1. Tool Documentation
Implements a waf tool to use Sphinx.
- f_sphinx_build.configure(conf)
Check if the following programs are available
sphinx-build,dot
- f_sphinx_build.rst(self, node)
dummy function to be able to use
bld(features="sphinx", source="abc*.rst", ...).
- class f_sphinx_build.sphinx_task(*args: Any, **kwargs: Any)
Bases:
waflib.Task.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-d569670869f772bca1c285b9b596a4f7f9f1889d.png)
Fig. 3.12 Input-output relation for conf.py
- always_run = True
Sphinx handles the need for a re-run, so always run this task
- Type
str
- check_output_html(std_out, std_err)
check if the html task generates any real errors
- check_output_linkcheck(std_out, std_err)
check if the linkcheck task generates any real errors
- check_output_spelling(std_out, std_err)
check if the spelling task generates any real errors
- 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
- static removedinsphinx30warning(_str)
The warning
RemovedInSphinx30Warningis not a valid warning in our build therefore it can skipped to fail the build.
