Skip to content

Commit 5f46ec5

Browse files
authored
Fix links for 1d plots in docs (#242)
1 parent 5fdad3e commit 5f46ec5

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/1dplots.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,11 @@
136136
#
137137
# The 1D :class:`~ultraplot.axes.PlotAxes` commands recognize `pandas`_
138138
# and `xarray`_ data structures. If you omit dependent variable coordinates,
139-
# the commands try to infer them from the `pandas.Series`, `pandas.DataFrame`,
140-
# or `xarray.DataArray`. If you did not explicitly set the *x* or *y* axis label
139+
# the commands try to infer them from the :class:`pandas.Series`, :class:`pandas.DataFrame`,
140+
# or :class:`xarray.DataArray`. If you did not explicitly set the *x* or *y* axis label
141141
# or :ref:`legend or colorbar <ug_guides_loc>` label(s), the commands
142-
# try to retrieve them from the `pandas.DataFrame` or `xarray.DataArray`.
143-
# The commands also recognize `pint.Quantity` structures and apply
142+
# try to retrieve them from the :class:`pandas.DataFrame` or :class:`xarray.DataArray`.
143+
# The commands also recognize :class:`pint.Quantity` structures and apply
144144
# unit string labels with formatting specified by :rc:`unitformat`.
145145
#
146146
# These features restore some of the convenience you get with the builtin
@@ -151,14 +151,14 @@
151151
#
152152
# .. note::
153153
#
154-
# For every plotting command, you can pass a `~xarray.Dataset`, :class:`~pandas.DataFrame`,
154+
# For every plotting command, you can pass a :class:`~xarray.Dataset`, :class:`~pandas.DataFrame`,
155155
# or `dict` to the `data` keyword with strings as data arguments instead of arrays
156156
# -- just like matplotlib. For example, ``ax.plot('y', data=dataset)`` and
157157
# ``ax.plot(y='y', data=dataset)`` are translated to ``ax.plot(dataset['y'])``.
158158
# This is the preferred input style for most `seaborn`_ plotting commands.
159-
# Also, if you pass a `pint.Quantity` or :class:`~xarray.DataArray`
160-
# containing a `pint.Quantity`, UltraPlot will automatically call
161-
# `~pint.UnitRegistry.setup_matplotlib` so that the axes become unit-aware.
159+
# Also, if you pass a :class:`pint.Quantity` or :class:`~xarray.DataArray`
160+
# containing a :class:`pint.Quantity`, UltraPlot will automatically call
161+
# :func:`~pint.UnitRegistry.setup_matplotlib` so that the axes become unit-aware.
162162

163163
# %%
164164
import xarray as xr
@@ -354,9 +354,9 @@
354354
# has the area :rcraw:`lines.markersize` squared. These minimum and maximum marker
355355
# sizes can also be specified manually with the `smin` and `smax` keywords,
356356
# analogous to `vmin` and `vmax` used to scale the color array `c`. This feature
357-
# can be disabled by passing ``absolute_size=True`` to :func:`~ultraplot.axes.Axes.scatter`
358-
# or :func:`~ultraplot.axes.Axes.scatterx`. This is done automatically when `seaborn`_
359-
# calls :func:`~ultraplot.axes.Axes.scatter` internally.
357+
# can be disabled by passing ``absolute_size=True`` to :func:`~ultraplot.axes.PlotAxes.scatter`
358+
# or :func:`~ultraplot.axes.PlotAxes.scatterx`. This is done automatically when `seaborn`_
359+
# calls :func:`~ultraplot.axes.PlotAxes.scatter` internally.
360360

361361
# %%
362362
import ultraplot as uplt
@@ -513,9 +513,9 @@
513513
# while UltraPlot bar widths are expressed in step size-relative units by
514514
# default. For example, ``width=1`` with a dependent coordinate step
515515
# size of ``2`` fills 100% of the space between each bar rather than 50%. This
516-
# can be disabled by passing ``absolute_width=True`` to :func:`~ultraplot.axes.Axes.bar`
517-
# or :func:`~ultraplot.axes.Axes.barh`. This is done automatically when `seaborn`_ calls
518-
# :func:`~ultraplot.axes.Axes.bar` or :func:`~ultraplot.axes.Axes.barh` internally.
516+
# can be disabled by passing ``absolute_width=True`` to :func:`~ultraplot.axes.PlotAxes.bar`
517+
# or :func:`~ultraplot.axes.PlotAxes.barh`. This is done automatically when `seaborn`_ calls
518+
# :func:`~ultraplot.axes.PlotAxes.bar` or :func:`~ultraplot.axes.PlotAxes.barh` internally.
519519

520520
# %%
521521
import ultraplot as uplt

docs/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Axes classes
5353
.. automodsumm:: ultraplot.axes
5454
:toctree: api
5555

56-
5756
Top-level functions
5857
===================
5958

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,7 @@ def __getattr__(self, name):
371371
(master_doc, "UltraPlot.tex", "UltraPlot Documentation", "UltraPlot", "manual"),
372372
]
373373

374+
primary_domain = "py"
374375

375376
# -- Options for manual page output ------------------------------------------
376377

0 commit comments

Comments
 (0)