Added rst checker

OSIPI · Jun 9, 2024 · 1eef4c2 · 1eef4c2
1 parent 18c874e
commit 1eef4c2
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -20,3 +20,9 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.1.2  # Use the latest version
+    hooks:
+      - id: rstcheck
+        args: ["--ignore-directives", "currentmodule,minigallery,autofunction,only,image-sg,rst-class,toctree,autosummary", "--ignore-roles", "ref"]
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -14,3 +14,4 @@ sphinxcontrib-qthelp
 sphinxcontrib-serializinghtml
 #nbsphinx
 sphinx-gallery
+rstcheck[sphinx]
diff --git a/docs/source/_templates/autosummary.rst b/docs/source/_templates/autosummary.rst
@@ -6,6 +6,7 @@
 
 {% if objtype in ['class'] %}
 .. auto{{ objtype }}:: {{ objname }}
+
     :show-inheritance:
     :special-members: __call__
 
@@ -16,11 +17,14 @@
 
 {% if objtype in ['class', 'method', 'function'] %}
 {% if objname in ['AxesGrid', 'Scalable', 'HostAxes', 'FloatingAxes',
+
                       '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: