Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

$ 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

extensions = ["sphinx_autodoc_pytest_fixtures"]

Then document fixtures with:

.. 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 for config values, directive options, and the badge demo.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_pytest_fixtures-0.1.0a37.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file sphinx_autodoc_pytest_fixtures-0.1.0a37.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.1.0a37.tar.gz
Algorithm Hash digest
SHA256 09ecc24389e5f3409b0d0d69bfdee248aa02e930da9f9228f13f127aa0291c36
MD5 a5a92f8be26a9f88a4468bc4063329c8
BLAKE2b-256 551f98693e1ae6e14248a3e5a5192c25da8a8c3ef4c2db549c793048a814135c

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_pytest_fixtures-0.1.0a37.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_autodoc_pytest_fixtures-0.1.0a37-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.1.0a37-py3-none-any.whl
Algorithm Hash digest
SHA256 f570b691b0a18f2d3ac551ddd0edb86f37ac2a8b72a2dfec18cd0cb0dcf59ccf
MD5 ae5752593e14d25f9b3e85bf5d900195
BLAKE2b-256 39473e505529230083042b77fc77b68e4b2445f1e2bbf6813171e835ca2b9792

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_pytest_fixtures-0.1.0a37-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0a37 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page