8000 Fix more doc references. · matplotlib/matplotlib@6d29b5c · GitHub
[go: up one dir, main page]
Skip to content

Commit 6d29b5c

Browse files
anntzeranntzer
committed
Fix more doc references.
Again fixing some broken some references from a PR that was CI'd before the missing-references.json PR. Here I just added proper reference targets for the mpl_toolkits.{axes_grid1,axisartis} modules.
1 parent 5e9c54e commit 6d29b5c

File tree

8 files changed

+12
-26
lines changed

8 files changed

+12
-26
lines changed

‎doc/api/next_api_changes/2018-02-10-AL.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The main differences are:
1616
``colorbar.yaxis`` depending on the orientation, rather than
1717
``colorbar.cbar_axis``.
1818
- Overdrawing multiple colorbars on top of one another in a single Axes (e.g.
19-
when using the ``cax`` attribute of `ImageGrid` elements) is not supported;
20-
if you previously relied on the second colorbar being drawn over the first,
21-
you can call ``cax.cla()`` to clear the axes before drawing the second
22-
colorbar.
19+
when using the ``cax`` attribute of `~.axes_grid1.ImageGrid` elements) is not
20+
supported; if you previously relied on the second colorbar being drawn over
21+
the first, you can call ``cax.cla()`` to clear the axes before drawing the
22+
second colorbar.
2323

2424
During the deprecation period, the ``mpl_toolkits.legacy_colorbar``
2525
rcParam can be set to True to use ``mpl_toolkits.axes_grid1.colorbar`` in

‎doc/api/toolkits/axes_grid1.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. _toolkit_axesgrid1-index:
1+
.. module:: mpl_toolkits.axes_grid1
22

33
Matplotlib axes_grid1 Toolkit
44
=============================
55

6-
The matplotlib :class:`mpl_toolkits.axes_grid1` toolkit is a collection of
6+
The matplotlib :mod:`mpl_toolkits.axes_grid1` toolkit is a collection of
77
helper classes to ease displaying multiple images in matplotlib. While the
88
aspect parameter in matplotlib adjust the position of the single axes,
99
axes_grid1 toolkit provides a framework to adjust the position of
@@ -16,8 +16,6 @@ See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1.
1616
:align: center
1717
:scale: 50
1818

19-
20-
2119
.. currentmodule:: mpl_toolkits
2220

2321
**The submodules of the axes_grid1 API are:**

‎doc/api/toolkits/axisartist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _toolkit_axisartist-index:
1+
.. module:: mpl_toolkits.axisartist
22

< 10000 /td>
33
Matplotlib axisartist Toolkit
44
=============================

‎doc/api/toolkits/index.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@
66
Toolkits
77
########
88

9-
10-
119
Toolkits are collections of application-specific functions that extend
1210
Matplotlib.
1311

14-
1512
.. _toolkit_mplot3d:
1613

1714
mplot3d
@@ -41,20 +38,11 @@ Links
4138
-----
4239
* mpl3d API: :ref:`toolkit_mplot3d-api`
4340

44-
.. _toolkit_axes_grid1_incl:
45-
4641
.. include:: axes_grid1.rst
4742
:start-line: 1
4843

49-
.. _toolkit_axisartist_incl:
50-
5144
.. include:: axisartist.rst
5245
:start-line: 1
5346

54-
.. _toolkit_axes_grid_incl:
55-
5647
.. include:: axes_grid.rst
5748
:start-line: 1
58-
59-
60-

‎examples/axes_grid1/simple_anchored_artists.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
=======================
55
66
This example illustrates the use of the anchored helper classes found in
7-
:py:mod:`~matplotlib.offsetbox` and in the :ref:`toolkit_axesgrid1-index`.
7+
:mod:`matplotlib.offsetbox` and in :mod:`mpl_toolkits.axes_grid1`.
88
An implementation of a similar figure, but without use of the toolkit,
99
can be found in :doc:`/gallery/misc/anchored_artists`.
1010
"""

‎examples/axisartist/demo_parasite_axes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
An alternative approach using standard Matplotlib subplots is shown in the
1313
:doc:`/gallery/ticks_and_spines/multiple_yaxis_with_spines` example.
1414
15-
An alternative approach using the :ref:`toolkit_axesgrid1-index`
16-
and :ref:`toolkit_axisartist-index` is found in the
15+
An alternative approach using :mod:`mpl_toolkits.axes_grid1`
16+
and :mod:`mpl_toolkits.axisartist` is found in the
1717
:doc:`/gallery/axisartist/demo_parasite_axes2` example.
1818
"""
1919

‎examples/misc/anchored_artists.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
================
55
66
This example illustrates the use of the anchored objects without the
7-
helper classes found in the :ref:`toolkit_axesgrid1-index`. This version
7+
helper classes found in :mod:`mpl_toolkits.axes_grid1`. This version
88
of the figure is similar to the one found in
99
:doc:`/gallery/axes_grid1/simple_anchored_artists`, but it is
1010
implemented using only the matplotlib namespace, without the help

‎tutorials/intermediate/tight_layout_guide.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ def example_plot(ax, fontsize=12):
316316
# Use with AxesGrid1
317317
# ==================
318318
#
319-
# While limited, the axes_grid1 toolkit is also supported.
319+
# While limited, :mod:`mpl_toolkits.axes_grid1` is also supported.
320320

321321
from mpl_toolkits.axes_grid1 import Grid
322322

0 commit comments

Comments
 (0)
0