more_autodoc.augment_defaults

Sphinx’s autodoc module allows for default options to be set, and allows for those defaults to be disabled for an :auto*: directive and different values given instead.

However, it does not appear to be possible to augment the defaults, such as to globally exclude certain members and then exclude additional members of a single class. This module monkeypatches in that behaviour.

Enable sphinx_toolbox.more_autodoc.augment_defaults by adding the following to the extensions variable in your conf.py:

extensions = [
    ...
    'sphinx_toolbox.more_autodoc.augment_defaults',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .

Changed in version 0.6.0: Moved from sphinx_toolbox.autodoc_augment_defaults.

Functions:

process_documenter_options(documenter, …)

Recognize options of Documenter from user input.

setup(app)

Setup sphinx_toolbox.more_autodoc.augment_defaults.

process_documenter_options(documenter, config, options)[source]

Recognize options of Documenter from user input.

Parameters
  • documenter (Type[Documenter])

  • config (Config)

  • options (Dict)

Return type

Options

setup(app)[source]

Setup sphinx_toolbox.more_autodoc.augment_defaults.

Parameters

app (Sphinx) – The Sphinx application.

Return type

SphinxExtMetadata