dispel.sphinxext.dispel_measures module#

Extensions to Sphinx to automatically document measures.

class dispel.sphinxext.dispel_measures.MeasureListDirective[source]#

Bases: DispelDirective

A directive to automatically document measure lists.

option_spec = {'name': <function unchanged_required>, 'steps': <function unchanged_required>}#

Mapping of option names to validator functions.

run()[source]#

Run the directive.

dispel.sphinxext.dispel_measures.get_variable(path)[source]#

Get the actual variable for a specified string.

Parameters:

path – The full module path and variable name of the variable of interest.

Returns:

The actual value at the specified path.

Return type:

object

dispel.sphinxext.dispel_measures.setup(app)[source]#

Run the set-up of the extension.

Parameters:

app (Sphinx) –