Deemphasize mpl_toolkits in API docs. · matplotlib/matplotlib@061c109 · GitHub
Skip to content

Commit 061c109

Browse files
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 061c109

5 files changed

Lines changed: 31 additions & 91 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: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
.. _toolkit_mplot3d-index:
2+
.. currentmodule:: mpl_toolkits.mplot3d
3+
4+
*******
5+
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
22+
the 3D scene. One can rotate the 3D scene by simply clicking-and-dragging
23+
the scene. Zooming is done by right-clicking the scene and dragging the
24+
mouse up and down. Note that one does not use the zoom button like one
25+
would use for regular 2D plots.
26+
27+
.. toctree::
28+
:maxdepth: 2
29+
30+
mplot3d/faq.rst
31+
132
.. _toolkit_mplot3d-api:
233

334
***********

doc/api/toolkits/mplot3d/index.rst

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

doc/index.rst

Lines changed: 0 additions & 2 deletions

0 commit comments

Comments
 (0)