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.0.1a34.tar.gz (32.7 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.0.1a34.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a34.tar.gz
Algorithm Hash digest
SHA256 e8745d05200babd1237930981039c808acab0d25f01f94716db7eb9bdd2c5820
MD5 1573b421bf3653da751038213602d223
BLAKE2b-256 76f70dcd3cd25effe0f0ef8d37a6cdb070cc30673c4c6f2fd1b2b119d5b892cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_pytest_fixtures-0.0.1a34.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.0.1a34-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a34-py3-none-any.whl
Algorithm Hash digest
SHA256 3036f24b276115c8bad412338f43c5c8411d5693f1aa41baf4a7c8474d9dd924
MD5 0a4765a2ad9267ac41710b35eaf4a2c3
BLAKE2b-256 10589075000f5e330b354667274c0521bc6c60933957fae18fc58db4bd795908

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_pytest_fixtures-0.0.1a34-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.0.1a34 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