DOC: user guide section on plotting methods

jklymak · jklymak · commit 235b82eb48b3 · 2024-11-12T09:28:21.000-08:00
diff --git a/doc/users/index.rst b/doc/users/index.rst
@@ -42,6 +42,15 @@ Using Matplotlib
 
             explain/axes/index
 
+    .. grid-item-card::
+        :padding: 2
+
+        .. toctree::
+            :maxdepth: 2
+            :includehidden:
+
+            explain/plotting/index
+
 
     .. grid-item-card::
         :padding: 2
diff --git a/galleries/examples/images_contours_and_fields/contour_demo.py b/galleries/examples/images_contours_and_fields/contour_demo.py
@@ -1,4 +1,6 @@
 """
+.. _contour_demo:
+
 ============
 Contour Demo
 ============
diff --git a/galleries/examples/images_contours_and_fields/contourf_demo.py b/galleries/examples/images_contours_and_fields/contourf_demo.py
@@ -1,4 +1,5 @@
 """
+.. _contourf_demo:
 =============
 Contourf demo
 =============
diff --git a/galleries/examples/images_contours_and_fields/contourf_log.py b/galleries/examples/images_contours_and_fields/contourf_log.py
@@ -1,4 +1,6 @@
 """
+.. _contourf_log:
+
 ============================
 Contourf and log color scale
 ============================
diff --git a/galleries/examples/images_contours_and_fields/image_antialiasing.py b/galleries/examples/images_contours_and_fields/image_antialiasing.py
@@ -1,4 +1,8 @@
 """
+.. _image_antialiasing:
+
+.. _image_resampling:
+
 ================
 Image resampling
 ================
diff --git a/galleries/examples/images_contours_and_fields/image_demo.py b/galleries/examples/images_contours_and_fields/image_demo.py
@@ -1,4 +1,6 @@
 """
+.. _image_demo:
+
 ========================
 Many ways to plot images
 ========================
diff --git a/galleries/examples/images_contours_and_fields/pcolor_demo.py b/galleries/examples/images_contours_and_fields/pcolor_demo.py
@@ -1,4 +1,6 @@
 """
+.. _pcolor_demo:
+
 =============
 pcolor images
 =============
diff --git a/galleries/examples/images_contours_and_fields/pcolormesh_grids.py b/galleries/examples/images_contours_and_fields/pcolormesh_grids.py
@@ -1,4 +1,6 @@
 """
+.. _pcolormesh_grids:
+
 ============================
 pcolormesh grids and shading
 ============================
diff --git a/galleries/examples/images_contours_and_fields/plot_streamplot.py b/galleries/examples/images_contours_and_fields/plot_streamplot.py
@@ -1,4 +1,6 @@
 """
+.. _plot_streamplot:
+
 ==========
 Streamplot
 ==========
diff --git a/galleries/examples/images_contours_and_fields/tricontour_demo.py b/galleries/examples/images_contours_and_fields/tricontour_demo.py
@@ -1,4 +1,6 @@
 """
+.. _tricontour_demo:
+
 ===============
 Tricontour Demo
 ===============
diff --git a/galleries/examples/images_contours_and_fields/tricontour_smooth_delaunay.py b/galleries/examples/images_contours_and_fields/tricontour_smooth_delaunay.py
@@ -1,4 +1,6 @@
 """
+.. _tricontour_smooth_delaunay:
+
 ==========================
 Tricontour Smooth Delaunay
 ==========================
diff --git a/galleries/examples/images_contours_and_fields/tricontour_smooth_user.py b/galleries/examples/images_contours_and_fields/tricontour_smooth_user.py
@@ -1,4 +1,6 @@
 """
+.. _tricontour_smooth_user:
+
 ======================
 Tricontour Smooth User
 ======================
diff --git a/galleries/examples/images_contours_and_fields/tripcolor_demo.py b/galleries/examples/images_contours_and_fields/tripcolor_demo.py
@@ -1,4 +1,6 @@
 """
+.. _tripcolor_demo:
+
 ==============
 Tripcolor Demo
 ==============
diff --git a/galleries/examples/images_contours_and_fields/triplot_demo.py b/galleries/examples/images_contours_and_fields/triplot_demo.py
@@ -1,4 +1,6 @@
 """
+.. _triplot_demo:
+
 ============
 Triplot Demo
 ============
diff --git a/galleries/examples/lines_bars_and_markers/categorical_variables.py b/galleries/examples/lines_bars_and_markers/categorical_variables.py
@@ -1,4 +1,6 @@
 """
+.. _categorical_variables:
+
 ==============================
 Plotting categorical variables
 ==============================
diff --git a/galleries/examples/lines_bars_and_markers/eventplot_demo.py b/galleries/examples/lines_bars_and_markers/eventplot_demo.py
@@ -1,4 +1,6 @@
 """
+.. _eventplot_demo:
+
 ==============
 Eventplot demo
 ==============
diff --git a/galleries/examples/lines_bars_and_markers/fill_between_demo.py b/galleries/examples/lines_bars_and_markers/fill_between_demo.py
@@ -1,4 +1,6 @@
 """
+.. _fill_between_demo:
+
 ===============================
 Fill the area between two lines
 ===============================
diff --git a/galleries/examples/lines_bars_and_markers/step_demo.py b/galleries/examples/lines_bars_and_markers/step_demo.py
@@ -1,4 +1,6 @@
 """
+.. _step_demo:
+
 =========
 Step Demo
 =========
diff --git a/galleries/examples/mplot3d/bars3d.py b/galleries/examples/mplot3d/bars3d.py
@@ -1,4 +1,6 @@
 """
+.. _bars3d:
+
 ========================================
 Create 2D bar graphs in different planes
 ========================================
diff --git a/galleries/examples/mplot3d/box3d.py b/galleries/examples/mplot3d/box3d.py
@@ -1,4 +1,6 @@
 """
+.. _box3d:
+
 ===================
 3D box surface plot
 ===================
diff --git a/galleries/examples/mplot3d/custom_shaded_3d_surface.py b/galleries/examples/mplot3d/custom_shaded_3d_surface.py
@@ -1,4 +1,6 @@
 """
+.. _custom_shaded_3d_surface:
+
 =======================================
 Custom hillshading in a 3D surface plot
 =======================================
diff --git a/galleries/examples/mplot3d/intersecting_planes.py b/galleries/examples/mplot3d/intersecting_planes.py
@@ -1,4 +1,6 @@
 """
+.. _intersecting_planes:
+
 ===================
 Intersecting planes
 ===================
diff --git a/galleries/examples/mplot3d/quiver3d.py b/galleries/examples/mplot3d/quiver3d.py
@@ -1,4 +1,6 @@
 """
+.. _quiver3d:
+
 ==============
 3D quiver plot
 ==============
diff --git a/galleries/examples/mplot3d/stem3d_demo.py b/galleries/examples/mplot3d/stem3d_demo.py
@@ -1,4 +1,6 @@
 """
+.. _stem3d_demo:
+
 =======
 3D stem
 =======
diff --git a/galleries/examples/mplot3d/surface3d.py b/galleries/examples/mplot3d/surface3d.py
@@ -1,4 +1,6 @@
 """
+.. _surface3d:
+
 =====================
 3D surface (colormap)
 =====================
diff --git a/galleries/examples/mplot3d/surface3d_2.py b/galleries/examples/mplot3d/surface3d_2.py
@@ -1,4 +1,6 @@
 """
+.. _surface3d_2:
+
 ========================
 3D surface (solid color)
 ========================
diff --git a/galleries/examples/mplot3d/surface3d_3.py b/galleries/examples/mplot3d/surface3d_3.py
@@ -1,4 +1,6 @@
 """
+.. _surface3d_3:
+
 =========================
 3D surface (checkerboard)
 =========================
diff --git a/galleries/examples/mplot3d/trisurf3d.py b/galleries/examples/mplot3d/trisurf3d.py
@@ -1,4 +1,6 @@
 """
+.. _trisurf3d:
+
 ======================
 Triangular 3D surfaces
 ======================
diff --git a/galleries/examples/mplot3d/trisurf3d_2.py b/galleries/examples/mplot3d/trisurf3d_2.py
@@ -1,4 +1,6 @@
 """
+.. _trisurf3d_2:
+
 ===========================
 More triangular 3D surfaces
 ===========================
diff --git a/galleries/examples/statistics/boxplot.py b/galleries/examples/statistics/boxplot.py
@@ -1,4 +1,6 @@
 """
+.. _boxplot_artists:
+
 =================================
 Artist customization in box plots
 =================================
diff --git a/galleries/examples/statistics/boxplot_color.py b/galleries/examples/statistics/boxplot_color.py
@@ -1,4 +1,6 @@
 """
+.. _boxplot_color:
+
 =================================
 Box plots with custom fill colors
 =================================
diff --git a/galleries/examples/statistics/boxplot_demo.py b/galleries/examples/statistics/boxplot_demo.py
@@ -1,4 +1,6 @@
 """
+.. _boxplot_demo:
+
 ========
 Boxplots
 ========
diff --git a/galleries/examples/statistics/boxplot_vs_violin.py b/galleries/examples/statistics/boxplot_vs_violin.py
@@ -1,4 +1,6 @@
 """
+.. _boxplot_vs_violin:
+
 ===================================
 Box plot vs. violin plot comparison
 ===================================
diff --git a/galleries/examples/statistics/customized_violin.py b/galleries/examples/statistics/customized_violin.py
@@ -1,4 +1,6 @@
 """
+.. _customized_violin:
+
 =========================
 Violin plot customization
 =========================
diff --git a/galleries/examples/statistics/hexbin_demo.py b/galleries/examples/statistics/hexbin_demo.py
@@ -1,4 +1,6 @@
 """
+.. _hexbin_demo:
+
 =====================
 Hexagonal binned plot
 =====================
diff --git a/galleries/examples/statistics/histogram_histtypes.py b/galleries/examples/statistics/histogram_histtypes.py
@@ -1,4 +1,6 @@
 """
+.. _histogram_histtypes:
+
 ================================================================
 Demo of the histogram function's different ``histtype`` settings
 ================================================================
diff --git a/galleries/examples/statistics/histogram_multihist.py b/galleries/examples/statistics/histogram_multihist.py
@@ -1,4 +1,6 @@
 """
+.. _histogram_multihist:
+
 =====================================================
 The histogram (hist) function with multiple data sets
 =====================================================
diff --git a/galleries/examples/statistics/histogram_normalization.py b/galleries/examples/statistics/histogram_normalization.py
@@ -1,5 +1,6 @@
 """
 .. redirect-from:: /gallery/statistics/histogram_features
+.. _histogram_normalization:
 
 ===================================
 Histogram bins, density, and weight
diff --git a/galleries/examples/statistics/violinplot.py b/galleries/examples/statistics/violinplot.py
@@ -1,4 +1,6 @@
 """
+.. _violinplot:
+
 ==================
 Violin plot basics
 ==================
diff --git a/galleries/plot_types/3D/bar3d_simple.py b/galleries/plot_types/3D/bar3d_simple.py
@@ -1,4 +1,6 @@
 """
+.. _bar3d_simple:
+
 ==========================
 bar3d(x, y, z, dx, dy, dz)
 ==========================
diff --git a/galleries/plot_types/3D/surface3d_simple.py b/galleries/plot_types/3D/surface3d_simple.py
@@ -1,4 +1,6 @@
 """
+.. _surface3d_simple:
+
 =====================
 plot_surface(X, Y, Z)
 =====================
diff --git a/galleries/plot_types/3D/trisurf3d_simple.py b/galleries/plot_types/3D/trisurf3d_simple.py
@@ -1,4 +1,6 @@
 """
+.. _trisurf3d_simple:
+
 =====================
 plot_trisurf(x, y, z)
 =====================
diff --git a/galleries/plot_types/arrays/pcolormesh.py b/galleries/plot_types/arrays/pcolormesh.py
@@ -1,7 +1,10 @@
 """
+.. _pcolormesh:
+
 ===================
 pcolormesh(X, Y, Z)
 ===================
+
 Create a pseudocolor plot with a non-regular rectangular grid.
 
 `~.axes.Axes.pcolormesh` is more flexible than `~.axes.Axes.imshow` in that
diff --git a/galleries/users_explain/artists/index.rst b/galleries/users_explain/artists/index.rst
@@ -1,3 +1,5 @@
+.. _users-guide-artists:
+
 +++++++
 Artists
 +++++++
diff --git a/galleries/users_explain/axes/index.rst b/galleries/users_explain/axes/index.rst
@@ -1,3 +1,5 @@
+.. _users_guide_axes:
+
 +++++++++++++++++
 Axes and subplots
 +++++++++++++++++
diff --git a/galleries/users_explain/plotting/gridded.py b/galleries/users_explain/plotting/gridded.py
diff --git a/galleries/users_explain/plotting/index.rst b/galleries/users_explain/plotting/index.rst
diff --git a/galleries/users_explain/plotting/pairwise.py b/galleries/users_explain/plotting/pairwise.py
diff --git a/galleries/users_explain/plotting/statistical.py b/galleries/users_explain/plotting/statistical.py
diff --git a/galleries/users_explain/plotting/threed.py b/galleries/users_explain/plotting/threed.py
diff --git a/galleries/users_explain/plotting/unstructuredgrid.py b/galleries/users_explain/plotting/unstructuredgrid.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""`
	`2`	`+.. _contourf_demo:`
`2`	`3`	`=============`
`3`	`4`	`Contourf demo`
`4`	`5`	`=============`