rstchecking precommit + fixing files with rst errors

story645 · story645 · commit e057fd4bdda7 · 2023-09-11T18:57:03.000-04:00
diff --git a/.pre-commit-config.yaml b/.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,21 @@ 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
+        args: [
+          "--ignore-directives",
+          "redirect-from, grid, tab-set, plot, mathmpl",
+          "--ignore-roles",
+          "rc"
+          ]
diff --git a/doc/api/next_api_changes/behavior/25775-HZ.rst b/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)
diff --git a/doc/api/prev_api_changes/api_changes_3.7.0/behaviour.rst b/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
diff --git a/doc/users/next_whats_new/antialiasing_text_annotation.rst b/doc/users/next_whats_new/antialiasing_text_annotation.rst
@@ -6,7 +6,7 @@ When *antialiased* is set to ``False``, antialiasing will not be applied to the
 When *antialiased* is not specified, antialiasing will be set by :rc:`text.antialiased` at the creation time of ``Text`` and ``Annotation`` object.
 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)
@@ -15,7 +15,7 @@ Examples:
 If the text contains math expression, *antialiased* applies to the whole text.
 Examples:
 
-.. code-block::
+.. code-block:: python
 
     # no part will be antialiased for the text below
     plt.text(0.5, 0.25, r"$I'm \sqrt{x}$", antialiased=False)
diff --git a/doc/users/next_whats_new/boldsym_mathtext.rst b/doc/users/next_whats_new/boldsym_mathtext.rst
@@ -6,7 +6,7 @@ Supports using the ``\boldsymbol{}`` command in mathtext:
 To change symbols to bold enclose the text in a font command as
 shown:
 
-.. code-block::
+.. code-block:: none
 
     r'$\boldsymbol{a+2+\alpha}$'
 
diff --git a/doc/users/next_whats_new/mathtext_features.rst b/doc/users/next_whats_new/mathtext_features.rst
@@ -5,7 +5,7 @@
 
 To use it to enclose the math in a substack command as shown:
 
-.. code-block::
+.. code-block:: none
 
     r'$\sum_{\substack{1\leq i\leq 3\\ 1\leq j\leq 5}}$'
 
@@ -23,7 +23,7 @@ The ``\middle`` delimiter has been added, and can now be used with the
 To use the middle command enclose it in between the ``\left`` and
 ``\right`` delimiter command as shown:
 
-.. code-block::
+.. code-block:: none
 
     r'$\left( \frac{a}{b} \middle| q \right)$'
 
diff --git a/doc/users/next_whats_new/updated_mathtext.rst b/doc/users/next_whats_new/updated_mathtext.rst
@@ -6,9 +6,9 @@ Supports use of bold-italic font style in mathtext using the ``\mathbfit{}`` com
 To change font to bold and italic enclose the text in a font command as
 shown:
 
-.. code-block::
+.. code-block:: python
 
-    r'$\mathbfit{\eta \leq C(\delta(\eta))}$
+    r'$\mathbfit{\eta \leq C(\delta(\eta))}$'
 
 .. math::
    \mathbfit{\eta \leq C(\delta(\eta))}
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
@@ -494,7 +494,7 @@ display an image of the colormap.
 
 .. only:: html
 
-    .. code-block::
+    .. code-block:: ipython
 
         In[1]: cmap = plt.get_cmap('viridis').with_extremes(bad='r', under='g', over='b')
 
diff --git a/doc/users/prev_whats_new/whats_new_3.5.0.rst b/doc/users/prev_whats_new/whats_new_3.5.0.rst
@@ -284,7 +284,7 @@ Simplifying the font setting for usetex mode
 Now the :rc:`font.family` accepts some font names as value for a more
 user-friendly setup.
 
-.. code-block::
+.. code-block:: python
 
     plt.rcParams.update({
         "text.usetex": True,
@@ -561,7 +561,7 @@ to block callback signals from being processed by the ``CallbackRegistry``.
 The optional keyword, *signal*, can be used to block a specific signal
 from being processed and let all other signals pass.
 
-.. code-block::
+.. code-block:: python
 
     import matplotlib.pyplot as plt
 
