Merge pull request #20573 from timhoffm/marker-path-reference

jklymak · web-flow · commit 6e49fd7619d5 · 2021-07-05T10:57:51.000-07:00
Move the marker path example into the marker reference
diff --git a/.flake8 b/.flake8
@@ -110,6 +110,7 @@ per-file-ignores =
     tutorials/toolkits/axisartist.py: E501
 
     examples/animation/frame_grabbing_sgskip.py: E402
+    examples/lines_bars_and_markers/marker_reference.py: E402
     examples/images_contours_and_fields/tricontour_demo.py: E201
     examples/images_contours_and_fields/tripcolor_demo.py: E201
     examples/images_contours_and_fields/triplot_demo.py: E201
diff --git a/examples/lines_bars_and_markers/marker_reference.py b/examples/lines_bars_and_markers/marker_reference.py
@@ -9,13 +9,14 @@
 - `Unfilled markers`_
 - `Filled markers`_
 - `Markers created from TeX symbols`_
-- Custom markers can be created from paths. See
-  :doc:`/gallery/shapes_and_collections/marker_path`.
+- `Markers created from Paths`_
 
 For a list of all markers see also the `matplotlib.markers` documentation.
 
 For example usages see
 :doc:`/gallery/lines_bars_and_markers/scatter_star_poly`.
+
+.. redirect-from:: /gallery/shapes_and_collections/marker_path
 """
 
 import matplotlib.pyplot as plt
@@ -126,3 +127,35 @@ def split_list(a_list):
 format_axes(ax)
 
 plt.show()
+
+
+###############################################################################
+# Markers created from Paths
+# ==========================
+#
+# Any `~.path.Path` can be used as a marker. The following example shows two
+# simple paths *star* and *circle*, and a more elaborate path of a circle with
+# a cut-out star.
+
+import matplotlib.path as mpath
+import numpy as np
+
+star = mpath.Path.unit_regular_star(6)
+circle = mpath.Path.unit_circle()
+# concatenate the circle with an internal cutout of the star
+cut_star = mpath.Path(
+    vertices=np.concatenate([circle.vertices, star.vertices[::-1, ...]]),
+    codes=np.concatenate([circle.codes, star.codes]))
+
+fig, ax = plt.subplots()
+fig.suptitle('Path markers', fontsize=14)
+fig.subplots_adjust(left=0.4)
+
+markers = {'star': star, 'circle': circle, 'cut_star': cut_star}
+
+for y, (name, marker) in enumerate(markers.items()):
+    ax.text(-0.5, y, name, **text_style)
+    ax.plot([y] * 3, marker=marker, **marker_style)
+format_axes(ax)
+
+plt.show()
diff --git a/examples/shapes_and_collections/marker_path.py b/examples/shapes_and_collections/marker_path.py
diff --git a/lib/matplotlib/markers.py b/lib/matplotlib/markers.py
@@ -83,7 +83,6 @@
 Examples showing the use of markers:
 
 * :doc:`/gallery/lines_bars_and_markers/marker_reference`
-* :doc:`/gallery/shapes_and_collections/marker_path`
 * :doc:`/gallery/lines_bars_and_markers/scatter_star_poly`
 
 
