[tests] update the pytest.mark.sphinx signature description (#12104)

sphinx-doc · Mar 16, 2024 · 16748ae · 16748ae
1 parent 4ca034b
commit 16748ae
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py
@@ -19,10 +19,14 @@
     from typing import Any
 
 DEFAULT_ENABLED_MARKERS = [
+    # The marker signature differs from the constructor signature
+    # since the way it is processed assumes keyword arguments for
+    # the 'testroot' and 'srcdir'.
     (
         'sphinx('
-        'buildername="html", /, *, '
-        'testroot="root", confoverrides=None, freshenv=False, '
+        'buildername="html", *, '
+        'testroot="root", srcdir=None, '
+        'confoverrides=None, freshenv=False, '
         'warningiserror=False, tags=None, verbosity=0, parallel=0, '
         'keep_going=False, builddir=None, docutils_conf=None'
         '): arguments to initialize the sphinx test application.'