0382d215db
The libcamera Sphinx documentation needs to link to the API documentation generated by Doxygen. The links currently point to the documentation hosted on the official https://libcamera.org/ website. This causes multiple issues: - Doxygen generates URLs with MD5 hashes of function signatures, making the link targets unstable. - When testing documentation builds that include API changes, links to new API elements will be broken. - The generated documentation can't be browsed offline. Fix this by using the Sphinx doxylink extension. This allows specifying link targets as class and function names, with the link being automatically generated using the same MD5 hashing as Doxygen. The root of the link target is configured in a central location, which defaults to the build directory and can be overridden to point to the libcamera website when pushing the documentation. This commit only introduces the infrastructure to use doxylink. Manual links will be replaced separately. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>
114 lines
3.5 KiB
Python
114 lines
3.5 KiB
Python
# SPDX-License-Identifier: CC-BY-SA-4.0
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file does only contain a selection of the most common options. For a
|
|
# full list see the documentation:
|
|
# http://www.sphinx-doc.org/en/master/config
|
|
|
|
# -- 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 = 'libcamera'
|
|
copyright = '2018-2025, The libcamera documentation authors'
|
|
author = 'The libcamera documentation authors'
|
|
|
|
# Version information is provided by the build environment, through the
|
|
# sphinx command line.
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
#
|
|
# needs_sphinx = '1.0'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.graphviz',
|
|
'sphinxcontrib.doxylink',
|
|
]
|
|
|
|
graphviz_output_format = 'svg'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = []
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'en'
|
|
|
|
# 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 = [
|
|
'documentation-contents.rst',
|
|
]
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = None
|
|
|
|
doxylink = {
|
|
'doxy-pub': (
|
|
'Documentation/api-html/tagfile.xml',
|
|
'../api-html/',
|
|
),
|
|
'doxy-int': (
|
|
'Documentation/internal-api-html/tagfile.xml',
|
|
'../internal-api-html/',
|
|
),
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'theme'
|
|
html_theme_path = ['.']
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
#
|
|
# html_theme_options = {}
|
|
|
|
# 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 = []
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
# to template names.
|
|
#
|
|
# The default sidebars (for documents that don't match any pattern) are
|
|
# defined by theme itself. Builtin themes are using these templates by
|
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
|
# 'searchbox.html']``.
|
|
#
|
|
# html_sidebars = {}
|