Skip to content

Commit 8cf4401

Browse files
committed
update intersphinx links
1 parent 2085c2f commit 8cf4401

File tree

2 files changed

+24
-22
lines changed

2 files changed

+24
-22
lines changed

docs/conf.py

+13-11
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ def __getattr__(self, name):
6363
# Print available system fonts
6464
from matplotlib.font_manager import fontManager
6565

66-
print("Font files:", end=" ")
67-
print(", ".join(os.path.basename(font.fname) for font in fontManager.ttflist))
66+
# print("Font files:", end=" ")
67+
# print(", ".join(os.path.basename(font.fname) for font in fontManager.ttflist))
6868

6969

7070
# -- Project information -------------------------------------------------------
@@ -224,15 +224,15 @@ def __getattr__(self, name):
224224
# Set up mapping for other projects' docs
225225
intersphinx_mapping = {
226226
"cycler": ("https://matplotlib.org/cycler/", None),
227-
"matplotlib": ("https://matplotlib.org/stable", None),
228-
"sphinx": ("http://www.sphinx-doc.org/en/stable", None),
229-
"python": ("https://docs.python.org/3", None),
230-
"numpy": ("https://docs.scipy.org/doc/numpy", None),
231-
"scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
232-
"xarray": ("http://xarray.pydata.org/en/stable", None),
233-
"cartopy": ("https://scitools.org.uk/cartopy/docs/latest", None),
234-
"basemap": ("https://matplotlib.org/basemap/stable", None),
235-
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
227+
"matplotlib": ("https://matplotlib.org/stable/", None),
228+
"sphinx": ("http://www.sphinx-doc.org/en/stable/", None),
229+
"python": ("https://docs.python.org/3/", None),
230+
"numpy": ("https://numpy.org/doc/stable/", None),
231+
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
232+
"xarray": ("https://docs.xarray.dev/en/stable/", None),
233+
"cartopy": ("https://scitools.org.uk/cartopy/docs/latest/", None), #
234+
"basemap": ("https://matplotlib.org/basemap/stable/", None),
235+
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
236236
"pint": ("https://pint.readthedocs.io/en/stable/", None),
237237
}
238238

@@ -291,6 +291,8 @@ def __getattr__(self, name):
291291
# The light-dark theme toggler overloads this, but set default anyway
292292
pygments_style = "none"
293293

294+
jupyter_execute_kwargs = {"cache": "yes"} # Enable caching
295+
294296

295297
# -- Options for HTML output -------------------------------------------------
296298

docs/projections.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@
3838
# ----------
3939
#
4040
# To create `polar axes <polar_>`_, pass ``proj='polar'`` to an axes-creation
41-
# command like `ultraplot.figure.Figure.add_subplot`. Polar axes are represented with the
41+
# command like :func:`~ultraplot.figure.Figure.add_subplot`. Polar axes are represented with the
4242
# :class:`~ultraplot.axes.PolarAxes` subclass, which has its own :func:`~ultraplot.axes.PolarAxes.format`
43-
# command. `ultraplot.axes.PolarAxes.format` facilitates polar-specific modifications
44-
# like changing the central radius `r0`, the zero azimuth location `theta0`,
43+
# command. :func:`~ultraplot.axes.PolarAxes.format` facilitates polar-specific modifications
44+
# like changing the central radius :param:`r0`, the zero azimuth location :param:`theta0`,
4545
# and the positive azimuthal direction `thetadir`. It also supports toggling and
4646
# configuring the "major" and "minor" gridline locations with `grid`, `rlocator`,
4747
# `thetalocator`, `gridminor`, `rminorlocator`, and `thetaminorlocator` and formatting
4848
# the gridline labels with `rformatter` and `thetaformatter` (analogous to `xlocator`,
49-
# `xformatter`, and `xminorlocator` used by :func:`ultraplot.axes.CartesianAxes.format`),
49+
# `xformatter`, and `xminorlocator` used by :func:`~ultraplot.axes.CartesianAxes.format`),
5050
# and creating "annular" or "sector" plots by changing the radial or azimuthal
51-
# bounds `rlim` and `thetalim`. Finally, since `ultraplot.axes.PolarAxes.format`
52-
# calls `ultraplot.axes.Axes.format`, it can be used to add axes titles, a-b-c
51+
# bounds `rlim` and `thetalim`. Finally, since :func:`~ultraplot.axes.PolarAxes.format`
52+
# calls :func:`~ultraplot.axes.Axes.format`, it can be used to add axes titles, a-b-c
5353
# labels, and figure titles.
5454
#
55-
# For details, see `ultraplot.axes.PolarAxes.format`.
55+
# For details, see :func:`~ultraplot.axes.PolarAxes.format`.
5656

5757
# %%
5858
import ultraplot as uplt
@@ -115,18 +115,18 @@
115115
#
116116
# To create geographic axes, pass ``proj='name'`` to an axes-creation command like
117117
# `ultraplot.figure.Figure.add_subplot`, where ``name`` is any valid :ref:`PROJ projection
118-
# name <proj_table>`. Alternatively, you can pass a `cartopy.crs.Projection` or
119-
# `~mpl_toolkits.basemap.Basemap` instance returned by the :class:`~ultraplot.constructor.Proj`
118+
# name <proj_table>`. Alternatively, you can pass a :class:`cartopy.crs.Projection` or
119+
# :class:`~mpl_toolkits.basemap.Basemap` instance returned by the :class:`~ultraplot.constructor.Proj`
120120
# :ref:`constructor function <why_constructor>` to `proj` (see below for details). If
121121
# you want to create your subplots :ref:`all-at-once <ug_subplot>` with e.g.
122122
# :func:`~ultraplot.ui.subplots` but need different projections for each subplot, you can pass
123123
# a list or dictionary to the `proj` keyword (e.g., ``proj=('cartesian', 'pcarree')``
124124
# or ``proj={2: 'pcarree'}`` -- see :func:`~ultraplot.figure.Figure.subplots` for details).
125-
# Geographic axes are represented with the `~ultraplot.axes.GeoAxes` subclass, which
125+
# Geographic axes are represented with the :class:`~ultraplot.axes.GeoAxes` subclass, which
126126
# has its own :func:`~ultraplot.axes.GeoAxes.format` command. `ultraplot.axes.GeoAxes.format`
127127
# facilitates :ref:`geographic-specific modifications <ug_geoformat>` like meridional
128128
# and parallel gridlines and land mass outlines. The syntax is very similar to
129-
# :func:`ultraplot.axes.CartesianAxes.format`. Note that the `proj` keyword and several of
129+
# :func:`~ultraplot.axes.CartesianAxes.format`. Note that the `proj` keyword and several of
130130
# the :func:`~ultraplot.axes.GeoAxes.format` keywords are inspired by the basemap API.
131131
# In the below example, we create and format a very simple geographic plot.
132132

0 commit comments

Comments
 (0)