Skip to content

Commit

Permalink
update intersphinx mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
jmineau committed Sep 4, 2024
1 parent 7363eac commit 1ba463e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 19 deletions.
47 changes: 29 additions & 18 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,15 @@
autodoc_mock_imports = [
'boto3',
'cartopy',
'cf-xarray',
'fastkml',
'geopandas',
'matplotlib',
'metpy',
'numpy',
'pandas',
'pint',
'pint-xarray',
'pyproj',
'rioxarray',
's3fs',
Expand All @@ -70,6 +73,7 @@
'synopticpy',
'tables',
'xarray',
'xesmf',
'zarr'
]
autodoc_typehints = "signature"
Expand All @@ -78,24 +82,31 @@

# Set up mapping for other projects' docs
intersphinx_mapping = {
'cartopy': ('https://scitools.org.uk/cartopy/docs/latest/', None),
'fastkml': ('https://fastkml.readthedocs.io/en/latest/', None),
'geopandas': ('https://geopandas.org/en/stable/', None),
'metpy': ('https://unidata.github.io/MetPy/latest/', None),
'matplotlib': ('https://matplotlib.org/', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
'pyproj': ('https://pyproj4.github.io/pyproj/stable/', None),
'python': ('https://docs.python.org/3/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
'rioxarray': ('https://corteva.github.io/rioxarray/stable/', None),
's3fs': ('https://s3fs.readthedocs.io/en/latest/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
'shapely': ('https://shapely.readthedocs.io/en/stable/', None),
'siphon': ('https://unidata.github.io/siphon/latest/', None),
'synopticpy': ('https://synopticpy.readthedocs.io/en/stable/', None),
'tables': ('https://www.pytables.org/', None),
'xarray': ('https://xarray.pydata.org/en/stable/', None),
'zarr': ('https://zarr.readthedocs.io/en/stable/', None)
'boto3': ('https://boto3.amazonaws.com/v1/documentation/api/latest', None),
'cartopy': ('https://scitools.org.uk/cartopy/docs/latest', None),
'cf-xarray': ('https://cf-xarray.readthedocs.io/en/latest', None),
'dask': ('https://docs.dask.org/en/stable', None),
'esmpy': ('https://earthsystemmodeling.org/esmpy_doc/release/latest/html', None),
'fastkml': ('https://fastkml.readthedocs.io/en/latest', None),
'geopandas': ('https://geopandas.org/en/stable', None),
'metpy': ('https://unidata.github.io/MetPy/latest', None),
'matplotlib': ('https://matplotlib.org/stable', None),
'numpy': ('https://numpy.org/doc/stable', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
'pint': ('https://pint.readthedocs.io/en/stable', None),
'pint-xarray': ('https://pint-xarray.readthedocs.io/en/stable', None),
'pyproj': ('https://pyproj4.github.io/pyproj/stable', None),
'python': ('https://docs.python.org/3', None),
'rioxarray': ('https://corteva.github.io/rioxarray/stable', None),
's3fs': ('https://s3fs.readthedocs.io/en/latest', None),
'scipy': ('https://docs.scipy.org/doc/scipy', None),
'shapely': ('https://shapely.readthedocs.io/en/stable', None),
'siphon': ('https://unidata.github.io/siphon/latest', None),
'synopticpy': ('https://synopticpy.readthedocs.io/en/stable', None),
'tables': ('https://www.pytables.org', None),
'xarray': ('https://docs.xarray.dev/en/stable', None),
'xesmf': ('https://xesmf.readthedocs.io/en/stable', None),
'zarr': ('https://zarr.readthedocs.io/en/stable', None)
}

numpydoc_show_class_members = False
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ dependencies = [
"cartopy",
"cf_xarray",
"dask",
"xesmf",
"fastkml",
"geopandas",
"lxml", # speeds up fastkml
Expand All @@ -31,6 +30,7 @@ dependencies = [
"tables",
"typing-extensions", # needed to import Self before 3.11
"xarray",
"xesmf",
]
license = {file = "LICENSE"}
classifiers = [
Expand Down

0 comments on commit 1ba463e

Please sign in to comment.