Skip to content

Commit 1e2d1a4

Browse files
authored
docs: nicer types in docs (#688)
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 4020e26 commit 1e2d1a4

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"sphinx.ext.autodoc",
2424
"sphinx.ext.viewcode",
2525
"sphinx_design",
26+
"sphinx_autodoc_typehints",
2627
]
2728

2829
# List of patterns, relative to source directory, that match files and
@@ -72,6 +73,7 @@
7273
("py:class", klass)
7374
for klass in [
7475
"Path",
76+
"pathlib._local.Path",
7577
"docutils.nodes.document",
7678
"docutils.nodes.Node",
7779
"docutils.nodes.Element",

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ rtd = [
8686
"sphinx-design",
8787
"sphinxcontrib-bibtex",
8888
"sympy",
89+
"sphinx-autodoc-typehints",
8990
]
9091
testing = [
9192
"coverage>=6.4",

0 commit comments

Comments
 (0)