diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index d8823e7cbbc..46d7ffbcad5 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -32,6 +32,7 @@ dependencies: - sparse - sphinx-autosummary-accessors - sphinx-book-theme >= 0.0.38 + - sphinx-codeautolink - sphinx-copybutton - sphinx-design - sphinx!=4.4.0 diff --git a/doc/conf.py b/doc/conf.py index b5e08b81b46..ae685da025e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -88,6 +88,7 @@ "IPython.sphinxext.ipython_console_highlighting", "nbsphinx", "sphinx_autosummary_accessors", + "sphinx_codeautolink", "sphinx.ext.linkcode", "sphinxext.opengraph", "sphinx_copybutton", @@ -121,6 +122,19 @@ autosummary_generate = True autodoc_typehints = "none" +# codeautolink +codeautolink_concat_default = True +codeautolink_global_preface = """ +import dask +import numpy as np +import pandas as pd +import xarray as xr +""" +codeautolink_inventory_map = { + "xarray.core.dataarray.DataArray": "xarray.DataArray", + "xarray.core.dataset.Dataset": "xarray.Dataset", +} + # Napoleon configurations napoleon_google_docstring = False