Function
docutils.utils.extract_extension_options

Signature

extract_extension_options(field_list, options_spec)

Documentation String

Return a dictionary mapping extension option names to converted values.

Parameters:
  • field_list: A flat field list without field arguments, where each field body consists of a single paragraph only.
  • options_spec: Dictionary mapping known option names to a conversion function such as int or float.
Exceptions:
  • KeyError for unknown option names.

  • ValueError for invalid option values (raised by the conversion

    function).

  • TypeError for invalid option value types (raised by conversion

    function).

  • DuplicateOptionError for duplicate options.

  • BadOptionError for invalid fields.

  • BadOptionDataError for invalid option data (missing name, missing data, bad quotes, etc.).