Skip to content

Deemphasize mpl_toolkits in API docs. #21003

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
Sep 7, 2021
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
15 changes: 0 additions & 15 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,21 +101,6 @@ Alphabetical list of modules:
widgets_api.rst
_api_api.rst
_enums_api.rst

Toolkits
--------

:ref:`toolkits-index` are collections of application-specific functions that extend
Matplotlib. The following toolkits are included:

.. toctree::
:hidden:

toolkits/index.rst

.. toctree::
:maxdepth: 1

toolkits/mplot3d.rst
toolkits/axes_grid1.rst
toolkits/axisartist.rst
Expand Down
46 changes: 0 additions & 46 deletions doc/api/toolkits/index.rst

This file was deleted.

32 changes: 28 additions & 4 deletions doc/api/toolkits/mplot3d.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
.. _toolkit_mplot3d-api:
.. _toolkit_mplot3d-index:
.. currentmodule:: mpl_toolkits.mplot3d

************************
``mpl_toolkits.mplot3d``
************************

The mplot3d toolkit adds simple 3D plotting capabilities (scatter, surface,
line, mesh, etc.) to Matplotlib by supplying an Axes object that can create
a 2D projection of a 3D scene. The resulting graph will have the same look
and feel as regular 2D plots. Not the fastest or most feature complete 3D
library out there, but it ships with Matplotlib and thus may be a lighter
weight solution for some use cases.

See the :doc:`mplot3d tutorial </tutorials/toolkits/mplot3d>` for
more information.

.. image:: /_static/demo_mplot3d.png
:align: center

The interactive backends also provide the ability to rotate and zoom the 3D
scene. One can rotate the 3D scene by simply clicking-and-dragging the scene.
Zooming is done by right-clicking the scene and dragging the mouse up and down
(unlike 2D plots, the toolbar zoom button is not used).

.. toctree::
:maxdepth: 2

***********
mplot3d API
***********
mplot3d/faq.rst

.. note::
`.pyplot` cannot be used to add content to 3D plots, because its function
Expand Down
28 changes: 0 additions & 28 deletions doc/api/toolkits/mplot3d/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/devel/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ The correct target folder can be found using::
python -c "import matplotlib.tests; print(matplotlib.tests.__file__.rsplit('/', 1)[0])"

An analogous copying of :file:`lib/mpl_toolkits/tests/baseline_images`
is necessary for testing the :ref:`toolkits`.
is necessary for testing ``mpl_toolkits``.

Run the tests
^^^^^^^^^^^^^
Expand Down
2 changes: 0 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Reference
- :doc:`Axes API <api/axes_api>` for *most* plotting methods
- :doc:`Figure API <api/figure_api>` for figure-level methods

- :doc:`Extra Toolkits <api/toolkits/index>`

How-tos
=======

Expand Down