Skip to main content

Sphinx extension for documenting pytest fixtures as first-class objects

Project description

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.

Install

$ pip install sphinx-autodoc-pytest-fixtures

Usage

extensions = ["sphinx_autodoc_pytest_fixtures"]

Then document fixtures with:

.. autofixture:: myproject.conftest.my_fixture

.. autofixtures:: myproject.conftest

.. autofixture-index:: myproject.conftest

Documentation

See the full documentation for config values, directive options, and the badge demo.

Project details


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.1a0.tar.gz (35.1 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.1a0.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a0.tar.gz
Algorithm Hash digest
SHA256 ec9f54f15a1ca3306a29d315ede309692771fcd8e6f8b545d00c084f40ab6efb
MD5 a9dc4818ed1bbf2b01fcb610c579499b
BLAKE2b-256 6bfdb03bcf916b27372a01a656600aa2c39558e0133b49b2633e39ae96013dc2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a0-py3-none-any.whl
Algorithm Hash digest
SHA256 e33a60c8efbec0d10c0789a381539c39c8e59d2e0c6d6aaf9c257d7f5f48e8f9
MD5 5feb59c42b91c39269fde17c9598ce5d
BLAKE2b-256 2aeb38914b8887daf5947c89ceb6d0edfe48bbe1d85fa44101965caf850f67b2

See more details on using hashes here.

Provenance

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

Supported by

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