Debian Codegraph @

doc/conf.py

raw
1 # Configuration file for the Sphinx documentation builder.
2 #
3 # This file only contains a selection of the most common options. For a full
4 # list see the documentation:
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7 # -- Path setup --------------------------------------------------------------
8
9 # If extensions (or modules to document with autodoc) are in another directory,
10 # add these directories to sys.path here. If the directory is relative to the
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
12 #
13 # import os
14 # import sys
15 # sys.path.insert(0, os.path.abspath('.'))
16
17 # -- Project information -----------------------------------------------------
18
19 project = "hdf5plugin"
20 copyright = (
21 "2016-2024, European Synchrotron Radiation Facility, Grenoble"
22 )
23 author = "ESRF"
24
25 # -- General configuration ---------------------------------------------------
26
27 # Add any Sphinx extension module names here, as strings. They can be
28 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29 # ones.
30 extensions = [
31 "sphinx.ext.autodoc",
32 "nbsphinx",
33 "sphinx_rtd_theme",
34 ]
35
36
37 # List of patterns, relative to source directory, that match files and
38 # directories to ignore when looking for source files.
39 # This pattern also affects html_static_path and html_extra_path.
40 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
41
42
43 # -- Options for HTML output -------------------------------------------------
44
45 # The theme to use for HTML and HTML Help pages. See the documentation for
46 # a list of builtin themes.
47 #
48 html_theme = "sphinx_rtd_theme"