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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a1.tar.gz
Algorithm Hash digest
SHA256 a6424d1a56d243886b0d78eb12b743b2449d3b1af0d0687c20e70aae010a6f26
MD5 901138f508352f589fe6e5784c2ffdab
BLAKE2b-256 ed1fd70118d2b81863a934a204ea889bf22bfe08a95ef57016fa8035a9e0a9ee

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_pytest_fixtures-0.0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 02759731fe70ccbb5b357b4e2afd1ce0c63fb99be28237f9d125b484c1a37cc7
MD5 c77d57978ab1649c6cdadf311bd6a878
BLAKE2b-256 0b367aa6d743db7f4dfa606c87637a4b521a64d833d9d6394ee72692db9ca03e

See more details on using hashes here.

Provenance

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