Add param links to docs (#170)

gjoseph92 · Sep 7, 2022 · 917cacf · 917cacf
1 parent fc326d0
commit 917cacf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
+    "sphinx_paramlinks",
     "nbsphinx",
     "jupyter_sphinx",
 ]
@@ -50,6 +51,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+paramlinks_hyperlink_param = 'name'
 autosummary_generate = True
 napoleon_use_param = True
 # set_type_checking_flag = True
@@ -115,7 +117,7 @@
     "rasterio": ("https://rasterio.readthedocs.io/en/latest/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "pystac": ("https://pystac.readthedocs.io/en/latest/", None),
-    "xarray": ("https://xarray.pydata.org/en/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
     "dask": ("https://docs.dask.org/en/latest/", None),
     "distributed": ("https://distributed.dask.org/en/latest/", None),
     "matplotlib": ("https://matplotlib.org/stable", None),

diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,6 +57,7 @@ docs = [
     "numpydoc<2.0.0,>=1.4.0",
     "pandoc<3.0.0,>=2.2",
     "sphinx-autodoc-typehints<2.0.0,>=1.18.3",
+    "sphinx-paramlinks>=0.5.4",
 ]
 style = [
     "flake8<5.0.0,>=4.0.1",