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.1a35.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.1a35.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a35.tar.gz
Algorithm Hash digest
SHA256 680119969ca4d6a8e3c01b6b2add1b1364cc10a042b3fb1c41da628d9b76b607
MD5 2d9bb95a35d6e21c57599a7592d9e6df
BLAKE2b-256 82966af438bdb4942db2dd31a9de47ede3b54ccc91efc0eaab6ad84be1c4dd17

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a35-py3-none-any.whl
Algorithm Hash digest
SHA256 bb97e61cf3035c37dd7488b87cf20407f52d489bf110156a16e49c294ab2598c
MD5 071ce9f0c0667b310ea27a5bebdfc2f0
BLAKE2b-256 3fd9b66fe137960ea9b4c1d82d9021c343be7faff43759cd895df78ad1f9e015

See more details on using hashes here.

Provenance

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