Function setup

doc/en/conf.py:284–328

(app: sphinx.application.Sphinx)

def setup(app: sphinx.application.Sphinx) -> None:
    app.add_crossref_type(
        "fixture",
        "fixture",
        objname="built-in fixture",
        indextemplate="pair: %s; fixture",
    )

    app.add_object_type(
        "globalvar",
        "globalvar",
        objname="global variable interpreted by pytest",
        indextemplate="pair: %s; global variable interpreted by pytest",
    )

    app.add_crossref_type(
        directivename="hook",
        rolename="hook",
        objname="pytest hook",
        indextemplate="pair: %s; hook",
    )

    # legacypath.py monkey-patches pytest.Testdir in. Import the file so
    # that autodoc can discover references to it.
    # Workaround for Sphinx bug with Python 3.14:
    # inspect.getsource() returns '\n' instead of raising OSError for classes
    # whose __module__ doesn't match the file they're defined in, causing
    # get_type_comment() to crash with IndexError on empty ast.parse result.
    # See: https://github.com/sphinx-doc/sphinx/issues/14345
    import sys

    import _pytest.legacypath  # noqa: F401

    if sys.version_info >= (3, 14):
        from sphinx.ext.autodoc._dynamic import _type_comments

        _orig_get_type_comment = _type_comments.get_type_comment

        def _get_type_comment_safe(obj: object, bound_method: bool = False) -> object:
            try:
                return _orig_get_type_comment(obj, bound_method)
            except IndexError:
                return None

        _type_comments.get_type_comment = _get_type_comment_safe  # type: ignore[assignment]