Skip to content

Commit 662a46a

Browse files
committed
add type hints to docs
1 parent 5997b9c commit 662a46a

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
'sphinx.ext.autosummary',
3737
'sphinx.ext.intersphinx',
3838
'sphinx.ext.napoleon',
39+
'sphinx_autodoc_typehints', # https://github.com/tox-dev/sphinx-autodoc-typehints/issues/15
3940
]
4041

4142
# Add any paths that contain templates here, relative to this directory.
@@ -67,6 +68,12 @@
6768

6869
# -- Extension configuration -------------------------------------------------
6970

71+
# https://github.com/tox-dev/sphinx-autodoc-typehints
72+
always_use_bars_union = True
73+
typehints_use_signature = True
74+
typehints_use_signature_return = True
75+
76+
7077
# -- Options for intersphinx extension ---------------------------------------
7178

7279
# Example configuration for intersphinx: refer to the Python standard library.

0 commit comments

Comments
 (0)