|
38 | 38 | # ----------
|
39 | 39 | #
|
40 | 40 | # 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 |
42 | 42 | # :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`, |
45 | 45 | # and the positive azimuthal direction `thetadir`. It also supports toggling and
|
46 | 46 | # configuring the "major" and "minor" gridline locations with `grid`, `rlocator`,
|
47 | 47 | # `thetalocator`, `gridminor`, `rminorlocator`, and `thetaminorlocator` and formatting
|
48 | 48 | # 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`), |
50 | 50 | # 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 |
53 | 53 | # labels, and figure titles.
|
54 | 54 | #
|
55 |
| -# For details, see `ultraplot.axes.PolarAxes.format`. |
| 55 | +# For details, see :func:`~ultraplot.axes.PolarAxes.format`. |
56 | 56 |
|
57 | 57 | # %%
|
58 | 58 | import ultraplot as uplt
|
|
115 | 115 | #
|
116 | 116 | # To create geographic axes, pass ``proj='name'`` to an axes-creation command like
|
117 | 117 | # `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` |
120 | 120 | # :ref:`constructor function <why_constructor>` to `proj` (see below for details). If
|
121 | 121 | # you want to create your subplots :ref:`all-at-once <ug_subplot>` with e.g.
|
122 | 122 | # :func:`~ultraplot.ui.subplots` but need different projections for each subplot, you can pass
|
123 | 123 | # a list or dictionary to the `proj` keyword (e.g., ``proj=('cartesian', 'pcarree')``
|
124 | 124 | # 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 |
126 | 126 | # has its own :func:`~ultraplot.axes.GeoAxes.format` command. `ultraplot.axes.GeoAxes.format`
|
127 | 127 | # facilitates :ref:`geographic-specific modifications <ug_geoformat>` like meridional
|
128 | 128 | # 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 |
130 | 130 | # the :func:`~ultraplot.axes.GeoAxes.format` keywords are inspired by the basemap API.
|
131 | 131 | # In the below example, we create and format a very simple geographic plot.
|
132 | 132 |
|
|
0 commit comments