32 lines
860 B
Python
32 lines
860 B
Python
# Sphinx configuration for the jfcal documentation.
|
|
|
|
# Make the jfcal package importable when building outside of CMake.
|
|
import importlib.util
|
|
import sys
|
|
import os
|
|
sys.path.insert(0, os.path.abspath(".."))
|
|
|
|
project = "jfcal"
|
|
author = "CPS Detector Group"
|
|
copyright = "2026, CPS Detector Group"
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.mathjax",
|
|
]
|
|
|
|
napoleon_numpy_docstring = True
|
|
napoleon_google_docstring = False
|
|
|
|
# Mock heavy runtime dependencies that are not installed in the docs environment.
|
|
_optional_deps = ["aare", "boost_histogram", "h5py", "hdf5plugin", "uproot", "matplotlib", "numpy"]
|
|
autodoc_mock_imports = [m for m in _optional_deps if importlib.util.find_spec(m) is None]
|
|
|
|
templates_path = []
|
|
exclude_patterns = ["_build"]
|
|
|
|
html_theme = "furo"
|