Function
docutils.utils.extract_options

[top] / docutils / utils / extract_options

Signature

extract_options(field_list)

Documentation String

Return a list of option (name, value) pairs from field names & bodies.

Parameter:

field_list: A flat field list, where each field name is a single word and each field body consists of a single paragraph only.
Exceptions:
  • BadOptionError for invalid fields.
  • BadOptionDataError for invalid option data (missing name, missing data, bad quotes, etc.).