Skip to content

Commit 070ded6

Browse files
committed
refactor(ext): Rename sphinx-pytest-fixtures to sphinx-autodoc-pytest-fixtures
why: Follow the sphinx-autodoc-* naming convention (like sphinx-autodoc-typehints). The name sphinx-autofixture is taken on PyPI. what: - Rename package dir, module, and CSS to sphinx_autodoc_pytest_fixtures - Update all 204 import/reference occurrences across source, tests, config - Register "integration" pytest marker (eliminates 54 warnings) - Fix unit test collection: replace pytest.importorskip in @skipif (aborted entire module at collection time) with try/except HAS_LIBTMUX pattern (72 previously-silent tests now run, 548 total) - Update libtmux references in pyproject.toml and docs/conf.py
1 parent 373fb47 commit 070ded6

21 files changed

Lines changed: 284 additions & 235 deletions
File renamed without changes.

packages/sphinx-pytest-fixtures/pyproject.toml renamed to packages/sphinx-autodoc-pytest-fixtures/pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[project]
2-
name = "sphinx-pytest-fixtures"
2+
name = "sphinx-autodoc-pytest-fixtures"
33
version = "0.0.1a0"
44
description = "Sphinx extension for documenting pytest fixtures as first-class objects"
55
requires-python = ">=3.10,<4.0"
@@ -40,4 +40,4 @@ requires = ["hatchling"]
4040
build-backend = "hatchling.build"
4141

4242
[tool.hatch.build.targets.wheel]
43-
packages = ["src/sphinx_pytest_fixtures"]
43+
packages = ["src/sphinx_autodoc_pytest_fixtures"]

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/__init__.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/__init__.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
.. note::
99
1010
This extension self-registers its CSS via ``add_css_file()``. The rules
11-
live in ``_static/css/sphinx_pytest_fixtures.css`` inside this package.
11+
live in ``_static/css/sphinx_autodoc_pytest_fixtures.css`` inside this package.
1212
"""
1313

1414
from __future__ import annotations
@@ -22,11 +22,11 @@
2222
# ---------------------------------------------------------------------------
2323
# Re-exports for backward compatibility (tests access these via the package)
2424
# ---------------------------------------------------------------------------
25-
from sphinx_pytest_fixtures._badges import (
25+
from sphinx_autodoc_pytest_fixtures._badges import (
2626
_BADGE_TOOLTIPS,
2727
_build_badge_group_node,
2828
)
29-
from sphinx_pytest_fixtures._constants import (
29+
from sphinx_autodoc_pytest_fixtures._constants import (
3030
_CONFIG_BUILTIN_LINKS,
3131
_CONFIG_EXTERNAL_LINKS,
3232
_CONFIG_HIDDEN_DEPS,
@@ -38,8 +38,8 @@
3838
PYTEST_HIDDEN,
3939
SetupDict,
4040
)
41-
from sphinx_pytest_fixtures._css import _CSS
42-
from sphinx_pytest_fixtures._detection import (
41+
from sphinx_autodoc_pytest_fixtures._css import _CSS
42+
from sphinx_autodoc_pytest_fixtures._detection import (
4343
_classify_deps,
4444
_get_fixture_fn,
4545
_get_fixture_marker,
@@ -49,30 +49,30 @@
4949
_is_pytest_fixture,
5050
_iter_injectable_params,
5151
)
52-
from sphinx_pytest_fixtures._directives import (
52+
from sphinx_autodoc_pytest_fixtures._directives import (
5353
AutofixtureIndexDirective,
5454
AutofixturesDirective,
5555
PyFixtureDirective,
5656
)
57-
from sphinx_pytest_fixtures._documenter import FixtureDocumenter
58-
from sphinx_pytest_fixtures._metadata import (
57+
from sphinx_autodoc_pytest_fixtures._documenter import FixtureDocumenter
58+
from sphinx_autodoc_pytest_fixtures._metadata import (
5959
_build_usage_snippet,
6060
_has_authored_example,
6161
_register_fixture_meta,
6262
)
63-
from sphinx_pytest_fixtures._models import (
63+
from sphinx_autodoc_pytest_fixtures._models import (
6464
FixtureDep,
6565
FixtureMeta,
6666
autofixture_index_node,
6767
)
68-
from sphinx_pytest_fixtures._store import (
68+
from sphinx_autodoc_pytest_fixtures._store import (
6969
_finalize_store,
7070
_get_spf_store,
7171
_on_env_merge_info,
7272
_on_env_purge_doc,
7373
_on_env_updated,
7474
)
75-
from sphinx_pytest_fixtures._transforms import (
75+
from sphinx_autodoc_pytest_fixtures._transforms import (
7676
_depart_abbreviation_html,
7777
_on_doctree_resolved,
7878
_on_missing_reference,
@@ -84,7 +84,7 @@
8484

8585

8686
def setup(app: Sphinx) -> SetupDict:
87-
"""Register the ``sphinx_pytest_fixtures`` extension.
87+
"""Register the ``sphinx_autodoc_pytest_fixtures`` extension.
8888
8989
Parameters
9090
----------
@@ -109,7 +109,7 @@ def _add_static_path(app: Sphinx) -> None:
109109
app.config.html_static_path.append(_static_dir)
110110

111111
app.connect("builder-inited", _add_static_path)
112-
app.add_css_file("css/sphinx_pytest_fixtures.css")
112+
app.add_css_file("css/sphinx_autodoc_pytest_fixtures.css")
113113

114114
# Override the built-in abbreviation visitor to emit tabindex when set.
115115
# Sphinx's default visit_abbreviation only passes explanation → title,

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_badges.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_badges.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
"""Badge group rendering helpers for sphinx_pytest_fixtures."""
1+
"""Badge group rendering helpers for sphinx_autodoc_pytest_fixtures."""
22

33
from __future__ import annotations
44

55
from docutils import nodes
66

7-
from sphinx_pytest_fixtures._constants import _SUPPRESSED_SCOPES
8-
from sphinx_pytest_fixtures._css import _CSS
7+
from sphinx_autodoc_pytest_fixtures._constants import _SUPPRESSED_SCOPES
8+
from sphinx_autodoc_pytest_fixtures._css import _CSS
99

1010
_BADGE_TOOLTIPS: dict[str, str] = {
1111
"session": "Scope: session \u2014 created once per test session",

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_constants.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_constants.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class SetupDict(t.TypedDict):
1717
# Extension identity and version
1818
# ---------------------------------------------------------------------------
1919

20-
_EXTENSION_KEY = "sphinx_pytest_fixtures"
20+
_EXTENSION_KEY = "sphinx_autodoc_pytest_fixtures"
2121
"""Domaindata namespace key used in ``env.domaindata``."""
2222

2323
_EXTENSION_VERSION = "1.0"

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_css.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_css.py

File renamed without changes.

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_detection.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_detection.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Fixture detection and classification helpers for sphinx_pytest_fixtures."""
1+
"""Fixture detection and classification helpers for sphinx_autodoc_pytest_fixtures."""
22

33
from __future__ import annotations
44

@@ -9,15 +9,15 @@
99
from sphinx.util import logging as sphinx_logging
1010
from sphinx.util.typing import stringify_annotation
1111

12-
from sphinx_pytest_fixtures._constants import (
12+
from sphinx_autodoc_pytest_fixtures._constants import (
1313
_CONFIG_BUILTIN_LINKS,
1414
_CONFIG_EXTERNAL_LINKS,
1515
_CONFIG_HIDDEN_DEPS,
1616
_DEFAULTS,
1717
PYTEST_BUILTIN_LINKS,
1818
PYTEST_HIDDEN,
1919
)
20-
from sphinx_pytest_fixtures._models import (
20+
from sphinx_autodoc_pytest_fixtures._models import (
2121
_FixtureFunctionDefinitionAdapter,
2222
_FixtureMarker,
2323
)

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_directives.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_directives.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Sphinx directive classes for sphinx_pytest_fixtures."""
1+
"""Sphinx directive classes for sphinx_autodoc_pytest_fixtures."""
22

33
from __future__ import annotations
44

@@ -13,7 +13,7 @@
1313
from sphinx.util.docfields import Field, GroupedField
1414
from sphinx.util.docutils import SphinxDirective
1515

16-
from sphinx_pytest_fixtures._constants import (
16+
from sphinx_autodoc_pytest_fixtures._constants import (
1717
_CALLOUT_MESSAGES,
1818
_CONFIG_BUILTIN_LINKS,
1919
_CONFIG_EXTERNAL_LINKS,
@@ -22,23 +22,23 @@
2222
_KNOWN_KINDS,
2323
PYTEST_BUILTIN_LINKS,
2424
)
25-
from sphinx_pytest_fixtures._css import _CSS
26-
from sphinx_pytest_fixtures._detection import (
25+
from sphinx_autodoc_pytest_fixtures._css import _CSS
26+
from sphinx_autodoc_pytest_fixtures._detection import (
2727
_get_fixture_fn,
2828
_get_fixture_marker,
2929
_is_pytest_fixture,
3030
)
31-
from sphinx_pytest_fixtures._metadata import (
31+
from sphinx_autodoc_pytest_fixtures._metadata import (
3232
_build_usage_snippet,
3333
_has_authored_example,
3434
_summary_insert_index,
3535
)
36-
from sphinx_pytest_fixtures._models import (
36+
from sphinx_autodoc_pytest_fixtures._models import (
3737
FixtureDep,
3838
FixtureMeta,
3939
autofixture_index_node,
4040
)
41-
from sphinx_pytest_fixtures._store import _get_spf_store, _resolve_builtin_url
41+
from sphinx_autodoc_pytest_fixtures._store import _get_spf_store, _resolve_builtin_url
4242

4343
if t.TYPE_CHECKING:
4444
pass

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_documenter.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_documenter.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
from sphinx.ext.autodoc import FunctionDocumenter
1010
from sphinx.util import logging as sphinx_logging
1111

12-
from sphinx_pytest_fixtures._constants import (
12+
from sphinx_autodoc_pytest_fixtures._constants import (
1313
_CONFIG_HIDDEN_DEPS,
1414
PYTEST_HIDDEN,
1515
)
16-
from sphinx_pytest_fixtures._detection import (
16+
from sphinx_autodoc_pytest_fixtures._detection import (
1717
_format_type_short,
1818
_get_fixture_fn,
1919
_get_fixture_marker,
@@ -22,7 +22,7 @@
2222
_infer_kind,
2323
_is_pytest_fixture,
2424
)
25-
from sphinx_pytest_fixtures._metadata import (
25+
from sphinx_autodoc_pytest_fixtures._metadata import (
2626
_extract_teardown_summary,
2727
_register_fixture_meta,
2828
)

packages/sphinx-pytest-fixtures/src/sphinx_pytest_fixtures/_index.py renamed to packages/sphinx-autodoc-pytest-fixtures/src/sphinx_autodoc_pytest_fixtures/_index.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Index table generation helpers for sphinx_pytest_fixtures."""
1+
"""Index table generation helpers for sphinx_autodoc_pytest_fixtures."""
22

33
from __future__ import annotations
44

@@ -10,15 +10,15 @@
1010
from sphinx.util import logging as sphinx_logging
1111
from sphinx.util.nodes import make_refnode
1212

13-
from sphinx_pytest_fixtures._badges import _build_badge_group_node
14-
from sphinx_pytest_fixtures._constants import (
13+
from sphinx_autodoc_pytest_fixtures._badges import _build_badge_group_node
14+
from sphinx_autodoc_pytest_fixtures._constants import (
1515
_IDENTIFIER_PATTERN,
1616
_INDEX_TABLE_COLUMNS,
1717
_RST_INLINE_PATTERN,
1818
)
19-
from sphinx_pytest_fixtures._css import _CSS
20-
from sphinx_pytest_fixtures._models import FixtureMeta, autofixture_index_node
21-
from sphinx_pytest_fixtures._store import FixtureStoreDict
19+
from sphinx_autodoc_pytest_fixtures._css import _CSS
20+
from sphinx_autodoc_pytest_fixtures._models import FixtureMeta, autofixture_index_node
21+
from sphinx_autodoc_pytest_fixtures._store import FixtureStoreDict
2222

2323
if t.TYPE_CHECKING:
2424
from sphinx.application import Sphinx

0 commit comments

Comments
 (0)