3.2.1.3. sphinx.ext.autodoc.assemble_option_dict

sphinx.ext.autodoc.assemble_option_dict(option_list, options_spec)[source]

Return a mapping of option names to values.

Parameters:
  • option_list: A list of (name, value) pairs (the output of extract_options()).
  • options_spec: Dictionary mapping known option names to a conversion function such as int or float.
Exceptions:
  • KeyError for unknown option names.

  • DuplicateOptionError for duplicate options.

  • ValueError for invalid option values (raised by conversion

    function).

  • TypeError for invalid option value types (raised by conversion

    function).