python-powersensor_local/docs/source/conf.py at 26f58f142908063ff36c5b34e11b5cabe0cc8c19 · DiUS/python-powersensor_local · 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
"""Sphinx configuration file for powersensor_local documentation."""

import sys
from pathlib import Path

# Add the package to the Python path
project_root = Path(__file__).parent.parent.parent
sys.path.insert(0, str(project_root / "src"))
print(project_root)

# Project information
project = "powersensor_local"
copyright = "2025, DiUS" # noqa A001
author = "Powersensor Team!"

html_favicon = "_static/powersensor-logo.png"
html_logo = "_static/powersensor-logo.png"

# The full version, including alpha/beta/rc tags
try:
    from powersensor_local import __version__ as release
except ImportError:
    release = "0.1.0"

version = ".".join(release.split(".")[:2])

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

# Napoleon settings (for Google and NumPy style docstrings)
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False

# Autodoc settings
autodoc_default_options = {
    "members": True,
    "undoc-members": True,
    "show-inheritance": True,
}

# Intersphinx mapping
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
}

# HTML theme
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_css_files = []


# Output file base name for HTML help builder
htmlhelp_basename = "powersensor_localdoc"

# Options for LaTeX output
latex_elements = {}
latex_documents = [
    ("index", "powersensor_local.tex", "powersensor_local Documentation", "Your Name", "manual"),
]

# Options for manual page output
man_pages = [
    ("index", "powersensor_local", "powersensor_local Documentation", [author], 1)
]

# Options for Texinfo output
texinfo_documents = [
    (
        "index",
        "powersensor_local",
        "powersensor_local Documentation",
        author,
        "powersensor_local",
        "One line description of project.",
        "Miscellaneous",
    ),
]