mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2026-11-04 23:03:12 +01:00
mazzol_a
56e880638e
Pybind11 merges all docstrings of overloaded functions into one docstring. Sphinx rendering usually complains about these merged docstrings e.g unexpected Section titles. Added a custom sphinx extension that overwrites the standard pybind11 method and function document handler. The handler splits the pybind generated docstring and adds for each overload its own method header.
65 lines
2.2 KiB
Python
65 lines
2.2 KiB
Python
# SPDX-License-Identifier: MPL-2.0
|
|
# 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:
|
|
# 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(os.path.dirname(__file__))) # finds pybind_overloads.py
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'aare'
|
|
copyright = '2024, CPS Detector Group'
|
|
author = 'CPS Detector Group'
|
|
version = '@PROJECT_VERSION@'
|
|
release = '@PROJECT_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.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'pybind_overloads',
|
|
]
|
|
|
|
breathe_default_project = "aare"
|
|
napoleon_use_ivar = True
|
|
napoleon_numpy_docstring = True
|
|
|
|
|
|
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# -- 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 = "furo"
|
|
|
|
# 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']
|
|
|
|
def setup(app):
|
|
app.add_css_file('extra.css') # relative to _static/; may also be an URL |