Deemphasize mpl_toolkits in API docs. · matplotlib/matplotlib@162f688 · GitHub
Skip to content

Commit 162f688

Browse files
anntzeranntzer
committed
Deemphasize mpl_toolkits in API docs.
The docs should present mpl_toolkits as more or less regular modules, that just happen to live in a different toplevel package for historical reasons. So just concatenate them to the end of the main module list. (This is particularly in preparation of the new website redesign, where the separate "Extra Toolkits" grouping is really too conspicuous on the front page.) Remove the toolkits/index page (documenting mplot3d and axis_grid/axisartist ("ag/aa") together doesn't make much sense except for this historical grouping), merging the mplot3d intro blurb together with the one previously at mplot3d/index.rst; the ag/aa blurbs were just included from the ag/aa API docs themselves and therefore don't need to be kept. The mplot3d intro blurb itself can go to the top of the mplot3d API docs, rather than needing a separate page.
1 parent 8ce14fb commit 162f688

6 files changed

Lines changed: 29 additions & 96 deletions

File tree

‎doc/api/index.rst‎

Lines changed: 0 additions & 15 deletions

‎doc/api/toolkits/index.rst‎

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎doc/api/toolkits/mplot3d.rst‎

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,32 @@
1-
.. _toolkit_mplot3d-api:
1+
.. _toolkit_mplot3d-index:
2+
.. currentmodule:: mpl_toolkits.mplot3d
3+
4+
************************
5+
``mpl_toolkits.mplot3d``
6+
************************
7+
8+
The mplot3d toolkit adds simple 3D plotting capabilities (scatter, surface,
9+
line, mesh, etc.) to Matplotlib by supplying an Axes object that can create
10+
a 2D projection of a 3D scene. The resulting graph will have the same look
11+
and feel as regular 2D plots. Not the fastest or most feature complete 3D
12+
library out there, but it ships with Matplotlib and thus may be a lighter
13+
weight solution for some use cases.
14+
15+
See the :doc:`mplot3d tutorial </tutorials/toolkits/mplot3d>` for
16+
more information.
17+
18+
.. image:: /_static/demo_mplot3d.png
19+
:align: center
20+
21+
The interactive backends also provide the ability to rotate and zoom the 3D
22+
scene. One can rotate the 3D scene by simply clicking-and-dragging the scene.
23+
Zooming is done by right-clicking the scene and dragging the mouse up and down
24+
(unlike 2D plots, the toolbar zoom button is not used).
25+
26+
.. toctree::
27+
:maxdepth: 2
228

3-
***********
4-
mplot3d API
5-
***********
29+
mplot3d/faq.rst
630

731
.. note::
832
`.pyplot` cannot be used to add content to 3D plots, because its function

‎doc/api/toolkits/mplot3d/index.rst‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎doc/devel/testing.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ The correct target folder can be found using::
244244
python -c "import matplotlib.tests; print(matplotlib.tests.__file__.rsplit('/', 1)[0])"
245245

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

249249
Run the tests
250250
^^^^^^^^^^^^^

‎doc/index.rst‎

Lines changed: 0 additions & 2 deletions

0 commit comments

Comments
 (0)