DuneSphinxDoc

Build Sphinx-based documentation from rst sources in the current project.

dune_sphinx_doc

Configure and build a Sphinx documentation tree from the current source directory.

dune_sphinx_doc(
  [CONF <conf.py-or-stem>]
  [BUILDTYPE <type>...]
)

CONF

Configuration file name used for Sphinx. If omitted, conf.py is used. If <conf>.in exists, it is configured with configure_file(). Otherwise the file is copied verbatim.

BUILDTYPE

Sphinx builders to invoke. If omitted, html is built.

For each requested build type, this command creates a target named sphinx_doc_<type> and also adds it as a dependency of the top-level doc target.

add_sphinx_targets

Convenience wrapper that declares the sphinx_files target, registers a set of documentation input files, and then calls dune_sphinx_doc().

add_sphinx_targets(<base> <file>...)

base

Prefix used for the generated helper target names.

file

Documentation input files copied into the Sphinx build tree. Notebook files with the .ipynb suffix are additionally converted to .rst when jupyter is available.

add_sphinx_target

Internal helper used by add_sphinx_targets() to register a single documentation input file.

add_sphinx_files

Internal helper used by add_sphinx_targets() to register multiple documentation input files.