Skip to content

Commit 8bdef69

Browse files
committed
Provide mypy typehints also for docs as a very clean solution
1 parent 6568a4d commit 8bdef69

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/source/conf.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
version = ".".join(release.split(".")[:2])
2525

2626
# -- General configuration ---------------------------------------------------
27-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2827

29-
# Extensions
30-
extensions = [
28+
extensions: list[str] = [
3129
"sphinx.ext.autodoc",
3230
"sphinx.ext.napoleon", # For Google/NumPy-style docstrings
3331
"sphinx.ext.viewcode",
@@ -37,14 +35,13 @@
3735
]
3836

3937
autoapi_type = "python"
40-
autoapi_dirs = ["../../src"]
41-
autoapi_ignore = ["*/__main__.py", "*/tests/*"]
38+
autoapi_dirs: list[str] = ["../../src"]
39+
autoapi_ignore: list[str] = ["*/__main__.py", "*/tests/*"]
4240

43-
templates_path = ["_templates"]
44-
exclude_patterns = []
41+
templates_path: list[str] = ["_templates"]
42+
exclude_patterns: list[str] = []
4543

4644
# -- Options for HTML output -------------------------------------------------
47-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4845

4946
html_theme = "sphinx_rtd_theme"
50-
html_static_path = ["_static"]
47+
html_static_path: list[str] = ["_static"]

0 commit comments

Comments
 (0)