Merge branch 'main' into mpl38

Author: dstansby

.github/workflows/main.yaml

@@ -22,8 +22,6 @@ jobs:
           sudo apt install \
             fontconfig    \
             imagemagick   \
-            libgeos++-dev \
-            libproj-dev   \
             poppler-utils
           python -m pip install --upgrade pip
           pip install -r requirements/requirements.txt

Makefile

@@ -46,8 +46,8 @@ check:
 	./check-num-pages.sh handout-tips.pdf 1
 	./check-num-pages.sh handout-beginner.pdf 1
 	./check-num-pages.sh handout-intermediate.pdf 1
-	./check-links.py cheatsheets.pdf
 	./check-diffs.py
+	./check-links.py cheatsheets.pdf
 
 .PHONY: docs
 docs:

cheatsheets.tex

@@ -301,13 +301,13 @@
   % --- Layout ---------------------------------------------------------------
   \begin{myboxed}{Subplots layout \hfill
       \API{https://matplotlib.org/tutorials/intermediate/gridspec.html} }
-  \plot{layout-subplot.pdf}{\textbf{subplot[s]}(rows,cols,…)}
+  \plot{layout-subplot.pdf}{\textbf{subplot[s]}(rows, cols, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.subplots.html}
        {\ttfamily fig, axs = plt.subplots(3, 3)}
        {}
-  \plot{layout-gridspec.pdf}{G = \textbf{gridspec}(rows,cols,…)}
+  \plot{layout-gridspec.pdf}{G = \textbf{gridspec}(rows,cols, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.gridspec.GridSpec.html}
-       {\ttfamily ax = G[0,:]}{}
+       {\ttfamily ax = G[0, :]}{}
   \plot{layout-inset.pdf}{ax.\textbf{inset\_axes}(extent)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.inset_axes.html}
        {}{}
@@ -338,7 +338,7 @@
 
   % --- Basic plots -----------------------------------------------------------
   \begin{myboxed}{Basic plots}
-  \plot{basic-plot.pdf}{\textbf{plot}([X],Y,[fmt],…)}
+  \plot{basic-plot.pdf}{\textbf{plot}([X], Y, [fmt], …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.plot.html}
        {\optional{X},
         \mandatory{Y},
@@ -347,7 +347,7 @@
         \optional{marker},
         \optional{linestyle}}
        {}
-  \plot{basic-scatter.pdf}{\textbf{scatter}(X,Y,…)}
+  \plot{basic-scatter.pdf}{\textbf{scatter}(X, Y, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.scatter.html}
        {\mandatory{X},
         \mandatory{Y},
@@ -356,23 +356,23 @@
         \optional{marker},
         \optional{cmap}}
        {}
-  \plot{basic-bar.pdf}{\textbf{bar[h]}(x,height,…)}
+  \plot{basic-bar.pdf}{\textbf{bar[h]}(x, height, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.bar.html}
        { \mandatory{x},
          \mandatory{height},
          \optional{width},
          \optional{bottom},
          \optional{align},
          \optional{color} }{}
-  \plot{basic-imshow.pdf}{\textbf{imshow}(Z,…)}
+  \plot{basic-imshow.pdf}{\textbf{imshow}(Z, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html}
        { \mandatory{Z},
          \optional{cmap},
          \optional{interpolation},
          \optional{extent},
          \optional{origin} }
        {}
-  \plot{basic-contour.pdf}{\textbf{contour[f]}([X],[Y],Z,…)}
+  \plot{basic-contour.pdf}{\textbf{contour[f]}([X], [Y], Z, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.contour.html}
        { \optional{X},
          \optional{Y},
@@ -382,7 +382,7 @@
          \optional{extent},
          \optional{origin} }
        {}
-  \plot{basic-pcolormesh.pdf}{\textbf{pcolormesh}([X],[Y],Z,…)}
+  \plot{basic-pcolormesh.pdf}{\textbf{pcolormesh}([X], [Y], Z, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.pcolormesh.html}
        { \optional{X},
          \optional{Y},
@@ -391,7 +391,7 @@
          \optional{vmax},
          \optional{cmap}}
        {}
-  \plot{basic-quiver.pdf}{\textbf{quiver}([X],[Y],U,V,…)}
+  \plot{basic-quiver.pdf}{\textbf{quiver}([X], [Y], U, V, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html}
      { \optional{X},
        \optional{Y},
@@ -401,15 +401,15 @@
        \optional{units},
        \optional{angles} }
      {}
-  \plot{basic-pie.pdf}{\textbf{pie}(X,…)}
+  \plot{basic-pie.pdf}{\textbf{pie}(X, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.pie.html}
        {\mandatory{Z},
          \optional{explode},
          \optional{labels},
          \optional{colors},
          \optional{radius}}
        {}
-   \plot{basic-text.pdf}{\textbf{text}(x,y,text,…)}
+   \plot{basic-text.pdf}{\textbf{text}(x, y, text, …)}
        {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.text.html}
        {\mandatory{x},
         \mandatory{y},
@@ -432,7 +432,7 @@
   \vspace{\fill}
   % --- Advanced plots --------------------------------------------------------
   \begin{myboxed}{Advanced plots}
-  \plot{advanced-step.pdf}{\textbf{step}(X,Y,[fmt],…)}
+  \plot{advanced-step.pdf}{\textbf{step}(X, Y, [fmt], …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.step.html}
      {\mandatory{X},
       \mandatory{Y},
@@ -441,15 +441,15 @@
       \optional{marker},
       \optional{where} }
      {}
-  \plot{advanced-boxplot.pdf}{\textbf{boxplot}(X,…)}
+  \plot{advanced-boxplot.pdf}{\textbf{boxplot}(X, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.boxplot.html}
      { \mandatory{X},
        \optional{notch},
        \optional{sym},
        \optional{bootstrap},
        \optional{widths} }
      {}
-  \plot{advanced-errorbar.pdf}{\textbf{errorbar}(X,Y,xerr,yerr,…)}
+  \plot{advanced-errorbar.pdf}{\textbf{errorbar}(X,Y,xerr,yerr, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.errorbar.html}
      { \mandatory{X},
        \mandatory{Y},
@@ -465,14 +465,14 @@
       \optional{density},
       \optional{weights}}
      {}
-  \plot{advanced-violin.pdf}{\textbf{violinplot}(D,…)}
+  \plot{advanced-violin.pdf}{\textbf{violinplot}(D, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.violinplot.html}
      {\mandatory{D},
       \optional{positions},
       \optional{widths},
       \optional{vert} }
      {}
-  \plot{advanced-barbs.pdf}{\textbf{barbs}([X],[Y], U, V, …)}
+  \plot{advanced-barbs.pdf}{\textbf{barbs}([X], [Y], U, V, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.barbs.html}
      { \optional{X},
        \optional{Y},
@@ -483,13 +483,13 @@
        \optional{pivot},
        \optional{sizes} }
      {}
-  \plot{advanced-event.pdf}{\textbf{eventplot}(positions,…)}
+  \plot{advanced-event.pdf}{\textbf{eventplot}(positions, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.eventplot.html}
      {\mandatory{positions},
        \optional{orientation},
        \optional{lineoffsets} }
      {}
-  \plot{advanced-hexbin.pdf}{\textbf{hexbin}(X,Y,C,…)}
+  \plot{advanced-hexbin.pdf}{\textbf{hexbin}(X, Y, C, …)}
      {https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.hexbin.html}
      {\mandatory{X},
       \mandatory{Y},
@@ -503,7 +503,7 @@
   % --- Scale ---------------------------------------------------------------
   \begin{myboxed}{Scales \hfill
     \API{https://matplotlib.org/stable/api/scale_api.html}}
-  {\ttfamily ax.\textbf{set\_[xy]scale}(scale,…)}
+  {\ttfamily ax.\textbf{set\_[xy]scale}(scale, …)}
   \smallskip
   \scale{scale-linear.pdf}{\textbf{linear}}{any values}
   \scale{scale-log.pdf}{\textbf{log}}{values > 0}
@@ -516,7 +516,7 @@
   % --- Projections -----------------------------------------------------------
   \begin{myboxed}{Projections \hfill
       \API{https://matplotlib.org/stable/api/projections_api.html}}
-  {\ttfamily \textbf{subplot}(…,projection=p)}
+  {\ttfamily \textbf{subplot}(…, projection=p)}
   \smallskip
   \scale{projection-polar.pdf}{p='polar'}{}
   \scale{projection-3d.pdf}
@@ -906,7 +906,7 @@
 
   \begin{myboxed}{Legend placement}
     \includegraphics[width=\columnwidth]{legend-placement.pdf}
-    ax.\textbf{legend}(loc="string", bbox\_to\_anchor=(x,y))\\
+    ax.\textbf{legend}(loc="string", bbox\_to\_anchor=(x, y))\\
     \begin{tabular}{@{}p{0.33\columnwidth}
                        p{0.33\columnwidth}
                        p{0.33\columnwidth}@{}}
@@ -919,12 +919,12 @@
     \begin{tabular}{@{}p{0.495\columnwidth}
                        p{0.495\columnwidth}@{}}
       \scriptsize \rule{0pt}{1.25em}\noindent
-      \tiny A: upper right /  {\ttfamily (-0.1,0.9)} & \tiny B: center right / {\ttfamily (-0.1,0.5)}\\
-      \tiny C: lower right /  {\ttfamily (-0.1,0.1)} & \tiny D: upper left /   {\ttfamily (0.1,-0.1)}\\
-      \tiny E: upper center / {\ttfamily (0.5,-0.1)} & \tiny F: upper right /  {\ttfamily (0.9,-0.1)}\\
-      \tiny G: lower left /   {\ttfamily (1.1,0.1)} & \tiny H: center left /  {\ttfamily (1.1,0.5)}\\
-      \tiny I: upper left /   {\ttfamily (1.1,0.9)} & \tiny J: lower right /  {\ttfamily (0.9,1.1)}\\
-      \tiny K: lower center / {\ttfamily (0.5,1.1)} & \tiny L: lower left /   {\ttfamily (0.1,1.1)}
+      \tiny A: upper right /  {\ttfamily (-0.1, 0.9)} & \tiny B: center right / {\ttfamily (-0.1, 0.5)}\\
+      \tiny C: lower right /  {\ttfamily (-0.1, 0.1)} & \tiny D: upper left /   {\ttfamily (0.1, -0.1)}\\
+      \tiny E: upper center / {\ttfamily (0.5, -0.1)} & \tiny F: upper right /  {\ttfamily (0.9, -0.1)}\\
+      \tiny G: lower left /   {\ttfamily (1.1, 0.1)} & \tiny H: center left /  {\ttfamily (1.1, 0.5)}\\
+      \tiny I: upper left /   {\ttfamily (1.1, 0.9)} & \tiny J: lower right /  {\ttfamily (0.9, 1.1)}\\
+      \tiny K: lower center / {\ttfamily (0.5, 1.1)} & \tiny L: lower left /   {\ttfamily (0.1, 1.1)}
     \end{tabular}
   \end{myboxed}
   %
@@ -1000,12 +1000,12 @@
     plot(X, Y, marker="o", ls="")  \hfill fast%
     \vskip.5\baselineskip
     %
-    \textcolor{red}{for i in range(n): plot(X[i]) \hfill slow}\\
-    plot(sum([x+[None] for x in X],[])) \hfill fast%
+    \textcolor{red}{for i in range(n): plot(i, X[i], "o") \hfill slow}\\
+    plot(X, marker="o", ls="") \hfill fast%
     \vskip.5\baselineskip
     %
-    \textcolor{red}{cla(), imshow(…), canvas.draw() \hfill slow}\\
-    im.set\_data(…), canvas.draw() \hfill fast%
+    \textcolor{red}{cla(); imshow(…); canvas.draw() \hfill slow}\\
+    im.set\_data(…); canvas.draw() \hfill fast%
     \vskip.1\baselineskip
     }
   \end{myboxed}
@@ -1019,7 +1019,7 @@
     \href{https://yt-project.org/doc/index.html}{\textbf{yt}}: Volumetric data visualization\\
     \href{https://mpld3.github.io}{\textbf{mpld3}}: Bringing Matplotlib to the browser\\
     \href{https://datashader.org/}{\textbf{Datashader}}: Large data processing pipeline\\
-    \href{https://plotnine.readthedocs.io/en/latest/}{\textbf{plotnine}}: A grammar of graphics for Python
+    \href{https://plotnine.org/}{\textbf{plotnine}}: A grammar of graphics for Python
   \end{myboxed}
   %
   \begin{center}

check-links.py

@@ -8,12 +8,12 @@
 
 refs = [ref for ref in pdf.get_references() if ref.reftype == 'url']
 
-status_codes = list(map(lambda ref: pdfx.downloader.get_status_code(ref.ref), refs))
+status_codes = [pdfx.downloader.get_status_code(ref.ref) for ref in refs]
 
-broken_links = [refs[idx].ref for idx in range(len(refs)) if status_codes[idx] != 200]
+broken_links = [(ref.ref, code) for ref, code in zip(refs, status_codes) if code != 200]
 
 # it seems that Twitter does not respond well to the link checker and throws a 400
-if all(['twitter.com' in url for url in broken_links]):
+if all(['twitter.com' in url for url, _ in broken_links]):
     sys.exit(0)
 else:
     print('Broken links:', broken_links)

docs/conf.py

@@ -14,7 +14,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx_design"]
 
 # Add any paths that contain templates here, relative to this directory.
 

docs/index.rst

@@ -7,23 +7,21 @@ Matplotlib cheatsheets and handouts
 Cheatsheets
 ***********
 
-.. container:: twocol
+.. grid:: 2
 
-    .. container::
+    .. grid-item::
 
-      .. image:: ../cheatsheets-1.png
-         :width: 270px
-         :align: center
-         :alt: image of first page of cheatsheets
+        .. image:: ../cheatsheets-1.png
+            :width: 270px
+            :align: center
+            :alt: image of first page of cheatsheets
 
+    .. grid-item::
 
-    .. container::
-
-      .. image:: ../cheatsheets-2.png
-         :width: 270px
-         :align: center
-         :alt: image of second page of cheatsheets
-
+        .. image:: ../cheatsheets-2.png
+            :width: 270px
+            :align: center
+            :alt: image of second page of cheatsheets
 
 `Cheatsheets [pdf] <./cheatsheets.pdf>`_
 
@@ -32,36 +30,34 @@ Cheatsheets
 Handouts
 ********
 
-.. container:: twocol
-
-   .. container::
-
-      .. image:: ../handout-beginner.png
-         :width: 270px
-         :align: center
-         :alt: image of beginner handout
+.. grid:: 1 2 3 3
 
-      `Beginner [pdf] <./handout-beginner.pdf>`_
+    .. grid-item::
 
+        .. image:: ../handout-beginner.png
+            :width: 270px
+            :align: center
+            :alt: image of beginner handout
 
-   .. container::
+        `Beginner [pdf] <./handout-beginner.pdf>`_
 
-      .. image:: ../handout-intermediate.png
-         :width: 270px
-         :align: center
-         :alt: image of intermediate handout
+    .. grid-item::
 
-      `Intermediate [pdf] <./handout-intermediate.pdf>`_
+        .. image:: ../handout-intermediate.png
+            :width: 270px
+            :align: center
+            :alt: image of intermediate handout
 
+        `Intermediate [pdf] <./handout-intermediate.pdf>`_
 
-   .. container::
+    .. grid-item::
 
-      .. image:: ../handout-tips.png
-         :width: 270px
-         :align: center
-         :alt: image of tips handout
+        .. image:: ../handout-tips.png
+            :width: 270px
+            :align: center
+            :alt: image of tips handout
 
-      `Tips [pdf] <./handout-tips.pdf>`_
+        `Tips [pdf] <./handout-tips.pdf>`_
 
 Contribute
 **********