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
14import subprocess
15
16subprocess.call('cd ../../doxygen && doxygen Doxyfile && cd ../sphinx/source', shell=True)
17
18
19# -- Project information -----------------------------------------------------
20
21project = 'Blosc2'
22copyright = '2021, The Blosc Developers'
23author = 'The Blosc Developers'
24
25
26# -- General configuration ---------------------------------------------------
27
28# Add any Sphinx extension module names here, as strings. They can be
29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30# ones.
31extensions = [
32    'breathe',
33    'sphinx.ext.intersphinx',
34]
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# List of patterns, relative to source directory, that match files and
40# directories to ignore when looking for source files.
41# This pattern also affects html_static_path and html_extra_path.
42exclude_patterns = []
43
44
45# -- Options for HTML output -------------------------------------------------
46
47# The theme to use for HTML and HTML Help pages.  See the documentation for
48# a list of builtin themes.
49#
50html_theme = "pydata_sphinx_theme"
51
52# Add any paths that contain custom static files (such as style sheets) here,
53# relative to this directory. They are copied after the builtin static files,
54# so a file named "default.css" will overwrite the builtin "default.css".
55html_static_path = ['_static']
56
57html_css_files = [
58    'css/custom.css',
59]
60
61html_logo = "_static/blosc-logo_256.png"
62
63html_theme_options = {
64    "external_links": [
65        {"name": "Python Library", "url": "https://python-blosc2.readthedocs.io"},
66    ],
67    "github_url": "https://github.com/Blosc/c-blosc2",
68    "twitter_url": "https://twitter.com/Blosc2",
69}
70
71# -- Breathe configuration ---------------------------------------------------
72
73breathe_projects = {
74    "blosc2": "../../doxygen/xml/",
75}
76breathe_default_project = "blosc2"
77breathe_show_define_initializer = True
78breathe_order_parameters_first = True
79breathe_domain_by_extension = {"h": "c"}
80