scplotkit/docs/conf.py at main · philinscience/scplotkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
from __future__ import annotations

import sys
from pathlib import Path

sys.path.insert(0, str(Path(__file__).parent.parent / "src"))

import scplotkit  # noqa: E402

project = "scplotkit"
copyright = "2026, scplotkit contributors"
author = "scplotkit contributors"
release = scplotkit.__version__

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx.ext.autosummary",
    "sphinx_autodoc_typehints",
    "myst_nb",
]

templates_path = ["_templates"]
html_static_path = ["_static"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]

autosummary_generate = True
autodoc_default_options = {
    "members": True,
    "undoc-members": False,
    "show-inheritance": False,
}
autodoc_typehints = "description"
napoleon_google_docstring = False
napoleon_numpy_docstring = True

nb_execution_mode = "off"  # demonstration notebooks are committed pre-executed
myst_enable_extensions = ["colon_fence"]

html_theme = "sphinx_book_theme"
html_title = "scplotkit"
html_logo = "_static/logo.png"
html_favicon = "_static/logo.png"
html_css_files = ["custom.css"]
html_theme_options = {
    "repository_url": "https://github.com/philinscience/scplotkit",
    "use_repository_button": True,
    "use_download_button": False,
}