API Reference¶
A Sphinx directive to specify that a module has extra requirements, and show how to install them.
Data:
Regular expression to match default values declared in docstrings. |
|
Regular expression to match flags in docstrings to suppress default values. |
Functions:
|
Format the value as a string. |
|
Returns a dictionary mapping argument names to parameters/arguments for a function. |
|
Obtains the default values for the arguments of a class. |
Obtains the default values for the arguments of a function. |
|
Prepare the formatting of the default value. |
|
|
Add default values to the docstring. |
|
Setup Sphinx Extension. |
-
default_regex
¶ Type:
Pattern
Regular expression to match default values declared in docstrings.
Pattern
^:(default|Default)[ ]
-
format_default_value
(value)[source]¶ Format the value as a string.
- Parameters
value (
Any
)
New in version 0.4.1.
-
get_arguments
(obj)[source]¶ Returns a dictionary mapping argument names to parameters/arguments for a function.
-
no_default_regex
¶ Type:
Pattern
Regular expression to match flags in docstrings to suppress default values.
Pattern
^:(No|no)[-_](default|Default)[ ]
-
process_default_format
(app)[source]¶ Prepare the formatting of the default value.
- Parameters
app (
Sphinx
)