Skip to content

Commit da5f688

Browse files
authored
create cross-references in docstring (#1083)
* create cross-references in docstring * add typing alias
1 parent d68171a commit da5f688

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,13 @@ def setup(app):
220220
),
221221
"ase": ("https://wiki.fysik.dtu.dk/ase/", None),
222222
}
223+
numpydoc_xref_param_type = True
224+
225+
226+
numpydoc_xref_aliases = {}
227+
import typing
228+
for typing_type in typing.__all__:
229+
numpydoc_xref_aliases[typing_type] = "typing.%s" % typing_type
223230

224231
# -- Options for HTML output -------------------------------------------------
225232

0 commit comments

Comments
 (0)