Merge branch 'main' into eyetracking-refactor

Author: 1himan

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   # Ruff mne
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.11
+    rev: v0.14.13
     hooks:
       - id: ruff-check
         name: ruff lint mne
@@ -33,7 +33,7 @@ repos:
 
   # yamllint
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.37.1
+    rev: v1.38.0
     hooks:
       - id: yamllint
         args: [--strict, -c, .yamllint.yml]
@@ -82,7 +82,7 @@ repos:
 
   # zizmor
   - repo: https://github.com/woodruffw/zizmor-pre-commit
-    rev: v1.20.0
+    rev: v1.22.0
     hooks:
       - id: zizmor
         args: [--fix]

doc/changes/dev/13596.other.rst

@@ -0,0 +1,2 @@
+Examples Using <some-method> section quirk fix in documentation, by :newcontrib:`Himanshu Mahor`.
+

doc/changes/names.inc

@@ -117,6 +117,7 @@
 .. _Harrison Ritz: https://github.com/harrisonritz
 .. _Hasrat Ali Arzoo: https://github.com/hasrat17
 .. _Henrich Kolkhorst: https://github.com/hekolk
+.. _Himanshu Mahor: https://github.com/1himan
 .. _Hongjiang Ye: https://github.com/ye-hongjiang
 .. _Hubert Banville: https://github.com/hubertjb
 .. _Hyonyoung Shin: https://github.com/mcvain

doc/sphinxext/gh_substitutions.py

@@ -2,8 +2,24 @@
 # License: BSD-3-Clause
 # Copyright the MNE-Python contributors.
 
+import docutils
 from docutils.nodes import reference
-from docutils.parsers.rst.roles import set_classes
+
+# Adapted from sphinx
+if docutils.__version_info__[:2] < (0, 22):
+    from docutils.parsers.rst import roles
+
+    def _normalize_options(options):
+        if options is None:
+            return {}
+        n_options = options.copy()
+        roles.set_classes(n_options)
+        return n_options
+
+else:
+    from docutils.parsers.rst.roles import (
+        normalize_options as _normalize_options,
+    )
 
 
 def gh_role(name, rawtext, text, lineno, inliner, options={}, content=[]):  # noqa: B006
@@ -22,7 +38,7 @@ def gh_role(name, rawtext, text, lineno, inliner, options={}, content=[]):  # no
         slug = "issues/" + text
     text = "#" + text
     ref = "https://github.com/mne-tools/mne-python/" + slug
-    set_classes(options)
+    options = _normalize_options(options)
     node = reference(rawtext, text, refuri=ref, **options)
     return [node], []
 

doc/sphinxext/mne_doc_utils.py

@@ -76,6 +76,16 @@ def reset_warnings(gallery_conf, fname):
         warnings.filterwarnings(  # deal with other modules having bad imports
             "ignore", message=f".*{key}.*", category=DeprecationWarning
         )
+    # ignore (PendingDeprecationWarning)
+    for key in (
+        # sphinx
+        "The mapping interface for autodoc options",
+        # sphinxcontrib-bibtex
+        "sphinx.environment.BuildEnvironment.app' is deprecated",
+    ):
+        warnings.filterwarnings(  # deal with other modules having bad imports
+            "ignore", message=f".*{key}.*", category=PendingDeprecationWarning
+        )
     # ignore (UserWarning)
     for message in (
         # Matplotlib