sciopy/docs/conf.py at 2b3dab1d712e56b4fb8191884860176e9209b3ee · EITLabworks/sciopy · 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
51
52
53
54
55
56
57
58
59
import os
import sys
from datetime import datetime

# Allow importing the package from repo root
sys.path.insert(0, os.path.abspath(".."))

project = "sciopy"
author = "Jacob P. Thönes"
release = "0.8.2.2"

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

autosummary_generate = True
autodoc_member_order = "bysource"
autodoc_typehints = "description"

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

# Project logo shown in the theme header
html_logo = "_static/logo_sciopy.jpg"

# Intersphinx mapping to useful external docs
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "pandas": ("https://pandas.pydata.org/docs/", None),
}

# Linkcheck settings (tolerate some known external issues)
linkcheck_ignore = [r"https://localhost:\d+/"]
linkcheck_timeout = 10

# Small helper for copyright line
copyright = f"{datetime.now().year}, {author}"

# Mock imports if building on CI without installing heavy deps (adjust as needed)
autodoc_mock_imports = [
    "numpy",
    "pandas",
    "matplotlib",
    "serial",
    "pyeit",
    "pyftdi",
    "pyserial",
    "tqdm",
]