Merge pull request matplotlib#26737 from story645/rst-linter

MNT: pre-commit rst linter + small linting fixes

Author: timhoffm

.pre-commit-config.yaml

@@ -26,7 +26,6 @@ repos:
       - id: no-commit-to-branch #default is master and main
       - id: trailing-whitespace
         exclude_types: [svg]
-
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
@@ -44,10 +43,15 @@ repos:
           "--skip",
           "doc/users/project/credits.rst"
           ]
-
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0
     hooks:
       - id: isort
         name: isort (python)
         files: ^galleries/tutorials/|^galleries/examples/|^galleries/plot_types/
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.0
+    hooks:
+      - id: rstcheck
+        additional_dependencies:
+          - sphinx>=1.8.1

doc/_templates/autofunctions.rst

@@ -14,7 +14,9 @@ Functions
 .. autosummary::
    :template: autosummary.rst
    :toctree:
+
 {% for item in functions %}{% if item not in ['plotting', 'colormaps'] %}
    {{ item }}{% endif %}{% endfor %}
+
 {% endif %}
 {% endblock %}

doc/_templates/automodule.rst

@@ -1,8 +1,10 @@
 {{ fullname | escape | underline}}
 
 {% if fullname in ['mpl_toolkits.axes_grid1.colorbar'] %}
-.. To prevent problems with the autosummary for the colorbar doc
-   treat this separately (sphinx-doc/sphinx/issues/4874)
+
+.. To prevent problems with the autosummary for the colorbar doc treat this
+   separately (sphinx-doc/sphinx/issues/4874)
+
 .. automodule:: {{ fullname }}
    :members:
 
@@ -21,8 +23,10 @@ Classes
 .. autosummary::
    :template: autosummary.rst
    :toctree:
+
 {% for item in classes %}{% if item not in ['zip', 'map', 'reduce'] %}
    {{ item }}{% endif %}{% endfor %}
+
 {% endif %}
 {% endblock %}
 
@@ -38,6 +42,7 @@ Functions
 
 {% for item in functions %}{% if item not in ['zip', 'map', 'reduce'] %}
    {{ item }}{% endif %}{% endfor %}
+
 {% endif %}
 {% endblock %}
 {% endif %}

doc/_templates/autosummary.rst

@@ -5,6 +5,7 @@
 
 
 {% if objtype in ['class'] %}
+
 .. auto{{ objtype }}:: {{ objname }}
     :show-inheritance:
     :special-members: __call__
@@ -16,11 +17,13 @@
 
 {% if objtype in ['class', 'method', 'function'] %}
 {% if objname in ['AxesGrid', 'Scalable', 'HostAxes', 'FloatingAxes',
-                      'ParasiteAxesAuxTrans', 'ParasiteAxes'] %}
+'ParasiteAxesAuxTrans', 'ParasiteAxes'] %}
+
 .. Filter out the above aliases to other classes, as sphinx gallery
    creates no example file for those (sphinx-gallery/sphinx-gallery#365)
 
 {% else %}
+
 .. minigallery:: {{module}}.{{objname}}
    :add-heading:
 

doc/_templates/autosummary_class_only.rst

@@ -5,6 +5,7 @@
 
 
 {% if objtype in ['class'] %}
+
 .. auto{{ objtype }}:: {{ objname }}
     :no-members:
 

doc/api/next_api_changes/behavior/25775-HZ.rst

@@ -4,7 +4,7 @@ Default antialiasing behavior changes for ``Text`` and ``Annotation``
 ``matplotlib.pyplot.annotate()`` and ``matplotlib.pyplot.text()`` now support parameter *antialiased* when initializing.
 Examples:
 
-.. code-block::
+.. code-block:: python
 
     mpl.text.Text(.5, .5, "foo\nbar", antialiased=True)
     plt.text(0.5, 0.5, '6 inches x 2 inches', antialiased=True)

doc/api/prev_api_changes/api_changes_2.1.2.rst

@@ -12,9 +12,9 @@ list of conditions was incomplete, didn't handle RGB tuples,
 didn't handle linewidths or linestyles etc.
 
 This logic did not exist in `.axes.Axes.legend`.  It was included (erroneously)
-in Matplotlib 2.1.1 when the legend argument parsing was unified
-[#9324](https://github.com/matplotlib/matplotlib/pull/9324).  This change
-removes that check in `.axes.Axes.legend` again to restore the old behavior.
+in Matplotlib 2.1.1 when the legend argument parsing was unified :ghpull:`9324`.  
+This change removes that check in `.axes.Axes.legend` again to restore the old 
+behavior.
 
 This logic has also been dropped from `.Figure.legend`, where it
 was previously undocumented. Repeated

doc/api/prev_api_changes/api_changes_3.5.0/behaviour.rst

@@ -132,7 +132,7 @@ consistently exposes all the attributes and methods related to the line marker
 (:ghissue:`11358`). This makes it easy to change the marker features after
 instantiating a legend.
 
-.. code::
+.. code-block:: python
 
     import matplotlib.pyplot as plt
 
@@ -147,7 +147,7 @@ instantiating a legend.
 The former legend handler for Line2D objects has been renamed
 `.HandlerLine2DCompound`. To revert to the previous behaviour, one can use
 
-.. code::
+.. code-block:: python
 
     import matplotlib.legend as mlegend
     from matplotlib.legend_handler import HandlerLine2DCompound

doc/api/prev_api_changes/api_changes_3.7.0/behaviour.rst

@@ -51,7 +51,7 @@ Now, the halfrange remains fixed when vcenter is changed, and **vmin** and
 
 For example, this is what the values were when changing vcenter previously.
 
-.. code-block::
+.. code-block:: python
 
     norm = CenteredNorm(vcenter=0, halfrange=1)
     # Move vcenter up by one
@@ -61,7 +61,7 @@ For example, this is what the values were when changing vcenter previously.
 
 and now, with that same example
 
-.. code-block::
+.. code-block:: python
 
     norm = CenteredNorm(vcenter=0, halfrange=1)
     norm.vcenter = 1

doc/devel/MEP/MEP23.rst

@@ -34,8 +34,8 @@ This is and may continue to be the desired method of operation for
 most use cases.
 
 Sometimes when there are too many figures open at the same time, it is
-desirable to be able to group these under the same window
-[see](https://github.com/matplotlib/matplotlib/issues/2194).
+desirable to be able to group these under the same window. See :ghpull:`2194`.
+
 
 The proposed solution modifies `.FigureManagerBase` to contain and manage more
 than one ``Canvas``. The settings parameter :rc:`backend.multifigure` control
@@ -44,7 +44,7 @@ when the **MultiFigure** behaviour is desired.
 **Note**
 
 It is important to note, that the proposed solution, assumes that the
-[MEP22](https://github.com/matplotlib/matplotlib/wiki/Mep22) is
+`MEP22 <https://github.com/matplotlib/matplotlib/wiki/Mep22>`_. is
 already in place. This is simply because the actual implementation of
 the ``Toolbar`` makes it pretty hard to switch between canvases.