API Reference

Directive reference

Generated from app.add_directive() registrations in sphinx_autodoc_pytest_fixtures/__init__.py via sphinx-autodoc-docutils.

.. fixture::

directive

directive

.. fixture::

Sphinx directive for documenting pytest fixtures: .. py:fixture::.

Options:

Python path:

sphinx_autodoc_pytest_fixtures._directives.PyFixtureDirective

Required arguments:

1

Optional arguments:

0

Final argument whitespace:

True

Has content:

True

:annotation:

option

option

:annotation:

Validator: unchanged.

:async:

option

option

:async:

Validator: flag.

:autouse:

option

option

:autouse:

Validator: flag.

:canonical:

option

option

:canonical:

Validator: unchanged.

:depends:

option

option

:depends:

Validator: unchanged.

:deprecated:

option

option

:deprecated:

Validator: unchanged.

:factory:

option

option

:factory:

Validator: flag.

:kind:

option

option

:kind:

Validator: unchanged.

:module:

option

option

:module:

Validator: unchanged.

:no-contents-entry:

option

option

:no-contents-entry:

Validator: flag.

:no-index:

option

option

:no-index:

Validator: flag.

:no-index-entry:

option

option

:no-index-entry:

Validator: flag.

:no-typesetting:

option

option

:no-typesetting:

Validator: flag.

:nocontentsentry:

option

option

:nocontentsentry:

Validator: flag.

:noindex:

option

option

:noindex:

Validator: flag.

:noindexentry:

option

option

:noindexentry:

Validator: flag.

:overridable:

option

option

:overridable:

Validator: flag.

:params:

option

option

:params:

Validator: unchanged.

:replacement:

option

option

:replacement:

Validator: unchanged.

:return-type:

option

option

:return-type:

Validator: unchanged.

:scope:

option

option

:scope:

Validator: unchanged.

:single-line-parameter-list:

option

option

:single-line-parameter-list:

Validator: flag.

:single-line-type-parameter-list:

option

option

:single-line-type-parameter-list:

Validator: flag.

:teardown:

option

option

:teardown:

Validator: flag.

:teardown-summary:

option

option

:teardown-summary:

Validator: unchanged.

:usage:

option

option

:usage:

Validator: unchanged.

.. autofixtures::

directive

directive

.. autofixtures::

Bulk fixture autodoc directive: .. autofixtures:: module.name.

Options:

Python path:

sphinx_autodoc_pytest_fixtures._directives.AutofixturesDirective

Required arguments:

1

Optional arguments:

0

Final argument whitespace:

False

Has content:

False

:exclude:

option

option

:exclude:

Validator: unchanged.

:no-index:

option

option

:no-index:

Validator: flag.

:order:

option

option

:order:

Validator: unchanged.

.. auto-pytest-plugin::

directive

directive

.. auto-pytest-plugin::

Render a reusable pytest-plugin documentation page block.

Options:

Python path:

sphinx_autodoc_pytest_fixtures._directives.AutoPytestPluginDirective

Required arguments:

1

Optional arguments:

0

Final argument whitespace:

False

Has content:

True

:install-command:

option

option

:install-command:

Validator: unchanged.

:package:

option

option

:package:

Validator: unchanged.

:project:

option

option

:project:

Validator: unchanged.

:summary:

option

option

:summary:

Validator: unchanged.

:tests-url:

option

option

:tests-url:

Validator: unchanged.

Extension entry point

sphinx_autodoc_pytest_fixtures.setup(app)

function

function

sphinx_autodoc_pytest_fixtures.setup(app)

Register the sphinx_autodoc_pytest_fixtures extension.

Parameters:

app (Sphinx) – The Sphinx application instance.

Returns:

Extension metadata dict.

Return type:

SetupDict