Metadata-Version: 2.4
Name: sphinx-autodoc-pytest-fixtures
Version: 0.0.1a24
Summary: Sphinx extension for documenting pytest fixtures as first-class objects
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: autodoc,documentation,fixtures,pytest,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Pytest
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Testing
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: pytest
Requires-Dist: sphinx-autodoc-typehints-gp==0.0.1a24
Requires-Dist: sphinx-ux-autodoc-layout==0.0.1a24
Requires-Dist: sphinx-ux-badges==0.0.1a24
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# sphinx-autodoc-pytest-fixtures

Sphinx extension that documents pytest fixtures as first-class domain objects
with scope badges, dependency tracking, reverse-dep graphs, and auto-generated
usage snippets.

The extension auto-loads the shared stack: `sphinx_ux_badges` owns badge
rendering, `sphinx_ux_autodoc_layout` owns the shared `api-*` regions and summary
wrappers, and `sphinx_autodoc_typehints_gp` owns fixture return-type rendering.

## Install

```console
$ pip install sphinx-autodoc-pytest-fixtures
```

Installing this package also installs `sphinx-ux-badges`,
`sphinx-ux-autodoc-layout`, and `sphinx-autodoc-typehints-gp` as declared dependencies.

## Usage

```python
extensions = ["sphinx_autodoc_pytest_fixtures"]
```

Then document fixtures with:

```rst
.. autofixture:: myproject.conftest.my_fixture

.. autofixtures:: myproject.conftest

.. auto-pytest-plugin:: myproject.pytest_plugin
   :project: myproject
   :package: myproject
   :summary: Document your pytest plugin with generated install and fixture
      reference sections.
```

## Documentation

See the [full documentation](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/) for
config values, directive options, and the badge demo.
