TYP: Improve the doc style for type hints (#2813)

Co-authored-by: Yvonne Fröhlich <[email protected]>
GenericMappingTools · Dec 7, 2023 · 7845ae8 · 7845ae8
1 parent 4a3ecdf
commit 7845ae8
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 0 deletions.
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
@@ -25,6 +25,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
@@ -23,6 +23,7 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinx_gallery.gen_gallery",
@@ -41,6 +42,9 @@
 napoleon_use_rtype = False
 napoleon_use_ivar = True
 
+# sphinx_auto_typehints
+typehints_defaults = "comma"
+
 # configure links to GMT docs
 extlinks = {
     "gmt-docs": ("https://docs.generic-mapping-tools.org/6.4/%s", None),

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