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

This commit is contained in:
Bénédikt Tran 2024-03-16 10:56:30 +01:00 committed by GitHub
parent 4ca034bbba
commit 16748aef2d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -19,10 +19,14 @@ if TYPE_CHECKING:
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.'