Skip to content

Commit b835d57

Browse files
committed
doc - Add autodoc typehints
1 parent 1953c42 commit b835d57

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx
2+
sphinx-autodoc-typehints

docs/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
# ones.
2626
extensions = [
2727
'sphinx.ext.autodoc',
28+
'sphinx_autodoc_typehints',
2829
'sphinx.ext.todo',
2930
'sphinx.ext.coverage',
3031
'sphinx.ext.viewcode',
@@ -93,6 +94,9 @@
9394
# If true, keep warnings as "system message" paragraphs in the built documents.
9495
#keep_warnings = False
9596

97+
# sphinx-autodoc-typehints options
98+
# If True, add stub documentation for undocumented parameters to be able to add type info.
99+
always_document_param_types = True
96100

97101
# -- Options for HTML output ----------------------------------------------
98102

0 commit comments

Comments
 (0)