93c2e7d686
* Use custom_target() instead of configured shell scripts * Do not copy all the .rst files in the build directory * Setup dependencies between targets * Tidy up dependencies lookup * Remove unused files * Upgrade Doxyfile to the latest version and cleanup used options
77 lines
2.5 KiB
Python
77 lines
2.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
#import os
|
|
#import sys
|
|
#sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'WirePlumber'
|
|
copyright = '2021, Collabora'
|
|
author = 'Collabora'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '@VERSION@'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'breathe',
|
|
'sphinx_rtd_theme',
|
|
]
|
|
|
|
breathe_projects = {
|
|
"WirePlumber": "@OUTDIR@/wp/xml",
|
|
"WirePlumber_Lua" : "@OUTDIR@/lua/xml",
|
|
}
|
|
breathe_default_members = ('members', 'undoc-members')
|
|
|
|
breathe_default_project = "WirePlumber"
|
|
|
|
# Exclude '.c' extension from breathe_implementation_filename_extensions so that the documented code in C files is parsed and the ReStructured Text files are built from xml files
|
|
breathe_implementation_filename_extensions = ['.cc', '.cpp']
|
|
|
|
# Let breathe know that our domain is 'C'
|
|
breathe_domain_by_extension = {
|
|
"h" : "c",
|
|
"c" : "c",
|
|
}
|
|
|
|
# See, https://breathe.readthedocs.io/en/latest/directives.html#config-values for more information
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
#templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['meson.build']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
#html_static_path = ['_static']
|
|
|
|
# Tell sphinx what the primary language being documented is.
|
|
primary_domain = 'c'
|