Use the sphinx-autodoc-typehints extension

GenericMappingTools · Nov 15, 2023 · 9ceacb9 · 9ceacb9
1 parent 5c5864c
commit 9ceacb9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -93,6 +93,7 @@ jobs:
             myst-parser
             panel
             sphinx
+            sphinx-autodoc-typehints
             sphinx-copybutton
             sphinx-design
             sphinx-gallery

diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -24,6 +24,7 @@ dependencies:
     - myst-parser
     - panel
     - sphinx
+    - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
     - sphinx-gallery

diff --git a/doc/conf.py b/doc/conf.py
@@ -28,6 +28,7 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinx_gallery.gen_gallery",

diff --git a/environment.yml b/environment.yml
@@ -37,7 +37,8 @@ dependencies:
     # Dev dependencies (building documentation)
     - myst-parser
     - panel
-    - sphinx
+    - sphinx>=3.0
+    - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
     - sphinx-gallery