docs: enabled "Type hints (PEP 484) support for the Sphinx autodoc ex…

…tension" (#421) * Enabled "Type hints (PEP 484) support for the Sphinx autodoc extension" * Add sphinx_autodoc_typehints to requirements-dev
HazyResearch · May 20, 2020 · 0dc064d · 0dc064d
1 parent 79434aa
commit 0dc064d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,10 @@
 Unreleased_
 -----------
 
+Changed
+^^^^^^^
+* `@HiromuHota`_: Enabled "Type hints (PEP 484) support for the Sphinx autodoc extension."
+
 0.8.2_ - 2020-04-28
 -------------------
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -52,7 +52,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -6,3 +6,4 @@ pre-commit
 pytest
 sphinx
 sphinx_rtd_theme
+sphinx_autodoc_typehints
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,4 @@ pre-commit @@
     pytest
     sphinx
     sphinx_rtd_theme
+    sphinx_autodoc_typehints