[Docs] Improve type hint style (#125)

2022-03-25 11:26:05 +08:00 · 2022-03-25 11:26:05 +08:00 · aee6d7a769
parent 248ad9aee8
commit aee6d7a769
2 changed files with 4 additions and 0 deletions
--- a/docs/en/conf.py
+++ b/docs/en/conf.py
@ -46,7 +46,9 @@ extensions = [
    'sphinx_markdown_tables',
    'myst_parser',
    'sphinx_copybutton',
+    'sphinx.ext.autodoc.typehints',
 ]  # yapf: disable
+autodoc_typehints = 'description'

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
--- a/docs/zh_cn/conf.py
+++ b/docs/zh_cn/conf.py
@ -50,7 +50,9 @@ extensions = [
    'sphinx_markdown_tables',
    'myst_parser',
    'sphinx_copybutton',
+    'sphinx.ext.autodoc.typehints',
 ]  # yapf: disable
+autodoc_typehints = 'description'

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']