8000 Fix more doc references. by anntzer · Pull Request #15088 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Fix more doc references. #15088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/api/next_api_changes/2018-02-10-AL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ The main differences are:
``colorbar.yaxis`` depending on the orientation, rather than
``colorbar.cbar_axis``.
- Overdrawing multiple colorbars on top of one another in a single Axes (e.g.
when using the ``cax`` attribute of `ImageGrid` elements) is not supported;
if you previously relied on the second colorbar being drawn over the first,
you can call ``cax.cla()`` to clear the axes before drawing the second
colorbar.
when using the ``cax`` attribute of `~.axes_grid1.axes_grid.ImageGrid`
elements) is not supported; if you previously relied on the second colorbar
being drawn over the first, you can call ``cax.cla()`` to clear the axes
before drawing the second colorbar.

During the deprecation period, the ``mpl_toolkits.legacy_colorbar``
rcParam can be set to True to use ``mpl_toolkits.axes_grid1.colorbar`` in
Expand Down
6 changes: 2 additions & 4 deletions doc/api/toolkits/axes_grid1.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _toolkit_axesgrid1-index:
.. module:: mpl_toolkits.axes_grid1

Matplotlib axes_grid1 Toolkit
=============================

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



.. currentmodule:: mpl_toolkits

**The submodules of the axes_grid1 API are:**
Expand Down
2 changes: 1 addition & 1 deletion doc/api/toolkits/axisartist.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _toolkit_axisartist-index:
.. module:: mpl_toolkits.axisartist

Matplotlib axisartist Toolkit
=============================
Expand Down
12 changes: 0 additions & 12 deletions doc/api/toolkits/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@
Toolkits
########



Toolkits are collections of application-specific functions that extend
Matplotlib.


.. _toolkit_mplot3d:

mplot3d
Expand Down Expand Up @@ -41,20 +38,11 @@ Links
-----
* mpl3d API: :ref:`toolkit_mplot3d-api`

.. _toolkit_axes_grid1_incl:

.. include:: axes_grid1.rst
:start-line: 1

.. _toolkit_axisartist_incl:

.. include:: axisartist.rst
:start-line: 1

.. _toolkit_axes_grid_incl:

.. include:: axes_grid.rst
:start-line: 1



2 changes: 1 addition & 1 deletion examples/axes_grid1/simple_anchored_artists.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
=======================

This example illustrates the use of the anchored helper classes found in
:py:mod:`~matplotlib.offsetbox` and in the :ref:`toolkit_axesgrid1-index`.
:mod:`matplotlib.offsetbox` and in :mod:`mpl_toolkits.axes_grid1`.
An implementation of a simila EDBE r figure, but without use of the toolkit,
can be found in :doc:`/gallery/misc/anchored_artists`.
"""
Expand Down
4 changes: 2 additions & 2 deletions examples/axisartist/demo_parasite_axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
An alternative approach using standard Matplotlib subplots is shown in the
:doc:`/gallery/ticks_and_spines/multiple_yaxis_with_spines` example.

An alternative approach using the :ref:`toolkit_axesgrid1-index`
and :ref:`toolkit_axisartist-index` is found in the
An alternative approach using :mod:`mpl_toolkits.axes_grid1`
and :mod:`mpl_toolkits.axisartist` is found in the
:doc:`/gallery/axisartist/demo_parasite_axes2` example.
"""

Expand Down
2 changes: 1 addition & 1 deletion examples/misc/anchored_artists.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
================

This example illustrates the use of the anchored objects without the
helper classes found in the :ref:`toolkit_axesgrid1-index`. This version
helper classes found in :mod:`mpl_toolkits.axes_grid1`. This version
of the figure is similar to the one found in
:doc:`/gallery/axes_grid1/simple_anchored_artists`, but it is
implemented using only the matplotlib namespace, without the help
Expand Down
2 changes: 1 addition & 1 deletion tutorials/intermediate/tight_layout_guide.py
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ def example_plot(ax, fontsize=12):
# Use with AxesGrid1
# ==================
#
# While limited, the axes_grid1 toolkit is also supported.
# While limited, :mod:`mpl_toolkits.axes_grid1` is also supported.

from mpl_toolkits.axes_grid1 import Grid

Expand Down
0