Skip to content

extension ¤

Classes:

AutoDocstringStyleExtension ¤

AutoDocstringStyleExtension(
    exclude: list[str] | None = None,
)

Bases: Extension

Set auto docstring style on external packages.

Parameters:

  • exclude (list[str] | None, default: None ) –

    Package names to exclude.

Methods:

  • on_instance

    Set docstring style to auto on all external Griffe objects.

on_instance ¤

on_instance(*, obj: Object, **kwargs: Any) -> None

Set docstring style to auto on all external Griffe objects.

Parameters:

  • obj (Object) –

    A Griffe object.

  • **kwargs (Any, default: {} ) –

    Additional arguments.