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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a36.tar.gz
Algorithm Hash digest
SHA256 6f93e14235db0fc364b1cd7aa7957c92b837899d342aa4335cd0909bdfbd1ea1
MD5 ca42cf8dad342fe78016872ad8717f70
BLAKE2b-256 8a13456af19d0aac194e58d130984644017cf58d0cee3b4523b75668548371fb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a36-py3-none-any.whl
Algorithm Hash digest
SHA256 fb4129590f67539b521f08d0248eb899a81967ea45368bd6ebd568cbf345bcaf
MD5 ef43b2ae960b997ad1acea0b44f7610b
BLAKE2b-256 30de8328e8039b146525a647f863ea0ea1f826a881cc7871277db9450410275c

See more details on using hashes here.

Provenance

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