DOC: Organize Axes3D methods into sections

j1642 · j1642 · commit a853d235c138 · 2022-11-04T22:42:15.000-04:00
diff --git a/doc/api/prev_api_changes/api_changes_3.0.0.rst b/doc/api/prev_api_changes/api_changes_3.0.0.rst
@@ -106,7 +106,7 @@ Different exception types for undocumented options
 - Passing the undocumented ``xmin`` or ``xmax`` arguments to
   :meth:`~matplotlib.axes.Axes.set_xlim` would silently override the ``left``
   and ``right`` arguments.  :meth:`~matplotlib.axes.Axes.set_ylim` and the
-  3D equivalents (e.g. `~.Axes3D.set_zlim3d`) had a
+  3D equivalents (e.g. `~.Axes3D.set_zlim`) had a
   corresponding problem.
   A ``TypeError`` will be raised if they would override the earlier
   limit arguments.  In 3.0 these were kwargs were deprecated, but in 3.1
diff --git a/doc/api/toolkits/mplot3d.rst b/doc/api/toolkits/mplot3d.rst
@@ -29,6 +29,7 @@ the toolbar pan and zoom buttons are not used.
 
    mplot3d/faq.rst
    mplot3d/view_angles.rst
+   mplot3d/axes3d.rst
 
 .. note::
    `.pyplot` cannot be used to add content to 3D plots, because its function
@@ -51,11 +52,8 @@ the toolbar pan and zoom buttons are not used.
    Please report any functions that do not behave as expected as a bug.
    In addition, help and patches would be greatly appreciated!
 
-.. autosummary::
-   :toctree: ../_as_gen
-   :template: autosummary.rst
 
-   axes3d.Axes3D
+`axes3d.Axes3D` (fig[, rect, elev, azim, roll, ...])    3D Axes object.
 
 
 .. module:: mpl_toolkits.mplot3d.axis3d
diff --git a/doc/api/toolkits/mplot3d/axes3d.rst b/doc/api/toolkits/mplot3d/axes3d.rst
@@ -0,0 +1,306 @@
+mpl\_toolkits.mplot3d.axes3d.Axes3D
+===================================
+
+
+.. currentmodule:: mpl_toolkits.mplot3d.axes3d
+
+
+.. autoclass:: Axes3D
+   :no-members:
+   :no-undoc-members:
+   :show-inheritance:
+
+
+.. currentmodule:: mpl_toolkits.mplot3d.axes3d.Axes3D
+
+
+Plotting
+--------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   plot
+   scatter
+   bar
+   bar3d
+
+   plot_surface
+   plot_wireframe
+   plot_trisurf
+
+   clabel
+   contour
+   tricontour
+   contourf
+   tricontourf
+
+   quiver
+   voxels
+   errorbar
+   stem
+
+
+Text and annotations
+--------------------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   text
+   text2D
+
+
+Clearing
+--------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   clear
+
+
+Appearance
+----------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   set_axis_off
+   set_axis_on
+   grid
+   get_frame_on
+   set_frame_on
+
+
+Axis
+----
+
+Axis limits and direction
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   get_zaxis
+   get_xlim
+   get_ylim
+   get_zlim
+   set_zlim
+   get_w_lims
+   invert_zaxis
+   zaxis_inverted
+   get_zbound
+   set_zbound
+
+
+Axis labels and title
+^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   set_zlabel
+   get_zlabel
+   set_title
+
+
+Axis scales
+^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   set_xscale
+   set_yscale
+   set_zscale
+   get_zscale
+
+
+Autoscaling and margins
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   set_zmargin
+   margins
+   autoscale
+   autoscale_view
+   set_autoscalez_on
+   get_autoscalez_on
+   auto_scale_xyz
+
+
+Aspect ratio
+^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   set_aspect
+   set_box_aspect
+   apply_aspect
+
+
+Ticks
+^^^^^
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   tick_params
+   set_zticks
+   get_zticks
+   set_zticklabels
+   get_zticklines
+   get_zgridlines
+   get_zminorticklabels
+   get_zmajorticklabels
+   zaxis_date
+
+
+Units
+-----
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   convert_zunits
+
+
+Adding artists
+--------------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   add_collection3d
+
+
+Sharing
+-------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   sharez
+
+
+Interactive
+-----------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   can_zoom
+   can_pan
+   disable_mouse_rotation
+   mouse_init
+   drag_pan
+   format_zdata
+   format_coord
+
+
+Projection and perspective
+--------------------------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   view_init
+   set_proj_type
+   get_proj
+   set_top_view
+
+
+Drawing
+-------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   draw
+   get_tightbbox
+
+
+Aliases and deprecated methods
+------------------------------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+    set_zlim3d
+    stem3D
+    text3D
+    tunit_cube
+    tunit_edges
+    unit_cube
+    w_xaxis
+    w_yaxis
+    w_zaxis
+
+
+Other
+-----
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   get_axis_position
+   add_contour_set
+   add_contourf_set
+   update_datalim
+
+
+.. currentmodule:: mpl_toolkits.mplot3d
+
+Sample 3D data
+--------------
+
+.. autosummary::
+   :toctree: ../../_as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   axes3d.get_test_data
+
+
+.. minigallery:: mpl_toolkits.mplot3d.axes3d.Axes3D
+   :add-heading:
diff --git a/doc/users/prev_whats_new/whats_new_3.4.0.rst b/doc/users/prev_whats_new/whats_new_3.4.0.rst
@@ -866,7 +866,7 @@ Stem plots in 3D Axes
 ---------------------
 
 Stem plots are now supported on 3D Axes. Much like 2D stems,
-`~.axes3d.Axes3D.stem3D` supports plotting the stems in various orientations:
+`~.axes3d.Axes3D.stem` supports plotting the stems in various orientations:
 
 .. plot::
 
diff --git a/examples/mplot3d/stem3d_demo.py b/examples/mplot3d/stem3d_demo.py
@@ -26,7 +26,7 @@
 # *linefmt*, *markerfmt*, and *basefmt* control basic format properties of the
 # plot. However, in contrast to `~.axes3d.Axes3D.plot` not all properties are
 # configurable via keyword arguments. For more advanced control adapt the line
-# objects returned by `.stem3D`.
+# objects returned by `~mpl_toolkits.mplot3d.axes3d.Axes3D.stem`.
 
 fig, ax = plt.subplots(subplot_kw=dict(projection='3d'))
 markerline, stemlines, baseline = ax.stem(
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -499,6 +499,9 @@ def get_axis_position(self):
         return xhigh, yhigh, zhigh
 
     def update_datalim(self, xys, **kwargs):
+        """
+        Not implemented in `~mpl_toolkits.mplot3d.axes3d.Axes3D`.
+        """
         pass
 
     get_autoscalez_on = _axis_method_wrapper("zaxis", "_get_autoscale_on")
