API Reference

A Sphinx directive to specify that a module has extra requirements, and show how to install them.

Functions:

process_docstring(app, what, name, obj, …)

Add default values to the docstring.

process_default_format(app)

Prepare the formatting of the default value.

setup(app)

Setup Sphinx Extension.
sphinxcontrib.default_values.process_default_format(app)[source]

Prepare the formatting of the default value.

Parameters

app (Sphinx) –

Return type

None

sphinxcontrib.default_values.process_docstring(app, what, name, obj, options, lines)[source]

Add default values to the docstring.

Parameters

  • app (Sphinx) –

  • what –

  • name –

  • obj –

  • options –

  • lines (List[str]) – List of strings representing the current contents of the docstring.

Return type

None

sphinxcontrib.default_values.setup(app)[source]

Setup Sphinx Extension.

Parameters

app (Sphinx) –

Return type

Dict[str, Any]

Returns