Module Expr Str Assign NameStore Str Import alias Import alias Import alias Import alias Import alias ImportFrom alias alias ImportFrom alias ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Call AttributeLoad NameLoad attr NameLoad Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases body Expr Str Assign NameStore Call AttributeLoad Str attr Expr Str Assign TupleStore NameStore NameStore NameStore NameStore NameStore Call NameLoad Num FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad Num Str Str body Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str If CompareIs NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr orelse If CompareIn Call NameLoad NameLoad TupleLoad NameLoad NameLoad body If CompareNotEq NameLoad Str body If CompareEq Call NameLoad NameLoad NameLoad body Assign NameStore Call NameLoad NameLoad Str orelse If CompareEq Call NameLoad NameLoad NameLoad body Assign NameStore Call NameLoad Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr ListLoad Expr Str Assign AttributeStore NameLoad attr Num Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad Num body Expr Call AttributeLoad NameLoad attr Str NameLoad keyword Num Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad If CompareIs NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body For NameStore AttributeLoad NameLoad attr body Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults vararg kwarg body Expr Str Assign NameStore Call AttributeLoad NameLoad attr If CompareIn Str NameLoad body Assign TupleStore NameStore NameStore Call NameLoad SubscriptLoad NameLoad Index Str Delete SubscriptDel NameLoad Index Str If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr Str NameLoad If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword NameLoad keyword SubscriptLoad AttributeLoad NameLoad attr Index NameLoad NameLoad NameLoad If BoolOpAnd AttributeLoad NameLoad attr BoolOpOr CompareGtE NameLoad AttributeLoad NameLoad attr BoolOpAnd AttributeLoad NameLoad attr CompareEq NameLoad AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Print AttributeLoad NameLoad attr NameLoad If CompareGtE NameLoad AttributeLoad NameLoad attr body Raise Call NameLoad NameLoad NameLoad If BoolOpOr CompareGt NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call NameLoad NameLoad AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str If AttributeLoad NameLoad attr body Return Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str Return Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str Return Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str Return Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str Return Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Pass decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore ListLoad For NameStore NameLoad body If CompareNotEq Call NameLoad Call AttributeLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr attr Num body Raise Call NameLoad Str Assign NameStore Call NameLoad Call AttributeLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr attr Assign NameStore SubscriptLoad NameLoad Index Num If CompareEq Call NameLoad NameLoad Num body Assign NameStore NameLoad orelse If BoolOpOr CompareGt Call NameLoad NameLoad Num UnaryOpNot Call NameLoad SubscriptLoad NameLoad Index Num AttributeLoad NameLoad attr CompareNotEq Call NameLoad SubscriptLoad NameLoad Index Num Num UnaryOpNot Call NameLoad SubscriptLoad SubscriptLoad NameLoad Index Num Index Num AttributeLoad NameLoad attr body Raise Call NameLoad BinOpMod Str NameLoad orelse Assign NameStore Call AttributeLoad SubscriptLoad SubscriptLoad NameLoad Index Num Index Num attr Expr Call AttributeLoad NameLoad attr TupleLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Dict For TupleStore NameStore NameStore NameLoad body Assign NameStore SubscriptLoad NameLoad Index NameLoad If CompareIs NameLoad NameLoad body Raise Call NameLoad NameLoad If CompareIn NameLoad NameLoad body Raise Call NameLoad BinOpMod Str NameLoad TryExcept body Assign SubscriptStore NameLoad Index NameLoad Call NameLoad NameLoad handlers ExceptHandler type TupleLoad NameLoad NameLoad name NameStore body Raise Call AttributeLoad NameLoad attr BinOpMod Str TupleLoad NameLoad NameLoad Call AttributeLoad Str attr AttributeLoad NameLoad attr Return NameLoad decorator_list ClassDef bases NameLoad body Pass decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore ListLoad While NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Str If CompareEq NameLoad Num body Raise Call NameLoad Str Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Slice NameLoad attr If BoolOpOr CompareEq NameLoad Num UnaryOpNot NameLoad body Raise Call NameLoad Str Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Slice BinOpAdd NameLoad Num attr If UnaryOpNot NameLoad body Raise Call NameLoad BinOpMod Str NameLoad If CompareIn SubscriptLoad NameLoad Index Num Str body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Num Num If CompareEq NameLoad Num body Raise Call NameLoad BinOpMod Str TupleLoad NameLoad SubscriptLoad NameLoad Index Num If BoolOpAnd CompareGt Call NameLoad NameLoad BinOpAdd NameLoad Num Call AttributeLoad SubscriptLoad NameLoad Index BinOpAdd NameLoad Num attr body Raise Call NameLoad BinOpMod Str TupleLoad NameLoad SubscriptLoad NameLoad Index Num Assign NameStore SubscriptLoad NameLoad Slice Num NameLoad Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Slice BinOpAdd NameLoad Num attr orelse Assign NameStore Call AttributeLoad NameLoad attr Str If CompareEq NameLoad Num body Assign NameStore NameLoad Assign NameStore Str orelse Assign NameStore SubscriptLoad NameLoad Slice NameLoad Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Slice BinOpAdd NameLoad Num attr Expr Call AttributeLoad NameLoad attr TupleLoad Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str ImportFrom alias If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore Call NameLoad NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Num Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If BoolOpAnd CompareEq Call NameLoad NameLoad Num Call NameLoad SubscriptLoad NameLoad Index Num AttributeLoad NameLoad attr body Assign NameStore SubscriptLoad NameLoad Index Num For TupleStore NameStore NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Assign SubscriptStore NameLoad Index Num Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr NameLoad NameLoad Return decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr BoolOpOr NameLoad Str attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad attr AttributeLoad NameLoad attr If CompareNotEq SubscriptLoad NameLoad Slice Num SubscriptLoad NameLoad Slice Num body Return Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr While BoolOpAnd NameLoad NameLoad CompareEq SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Index Num body Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Assign NameStore BinOpAdd BinOpMult ListLoad Str BinOpSub Call NameLoad NameLoad Num NameLoad Return Call AttributeLoad Str attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str If AttributeLoad NameLoad attr body Assert UnaryOpNot AttributeLoad NameLoad attr Str If CompareEq NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Return Call NameLoad NameLoad AttributeLoad NameLoad attr orelse Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str If AttributeLoad NameLoad attr body Assert UnaryOpNot AttributeLoad NameLoad attr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr Str orelse If AttributeLoad NameLoad attr body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str orelse Return ListLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs AttributeLoad NameLoad attr NameLoad body Return BoolOpAnd Call NameLoad NameLoad Str CompareEq AttributeLoad NameLoad attr Str orelse Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str While NameLoad body If BoolOpOr AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Return TupleLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore ListLoad Assign NameStore Num While Num body Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad If CompareEq NameLoad Num body Expr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Slice NameLoad Return Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Slice NameLoad NameLoad Expr Call AttributeLoad NameLoad attr BinOpAdd Str SubscriptLoad NameLoad Slice BinOpAdd NameLoad Num BinOpAdd NameLoad Num Assign NameStore BinOpAdd NameLoad Num decorator_list FunctionDef arguments args NameParam NameParam defaults Num body Expr Str If NameLoad body Return Call AttributeLoad NameLoad attr Str Str orelse For NameStore ListLoad Str Str Str body Assign NameStore Call AttributeLoad Str attr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list Assign NameStore Dict Str Str Str Str Str Str Num Num Num Num Num Num Expr Str FunctionDef arguments args NameParam defaults body If Call NameLoad NameLoad NameLoad body Assign NameStore Num For NameStore NameLoad body AugAssignAdd NameStore SubscriptLoad NameLoad Index Call AttributeLoad NameLoad attr NameLoad Return NameLoad orelse Return Call NameLoad NameLoad decorator_list If Call NameLoad NameLoad Str body Assign NameStore NameLoad orelse Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore ListLoad For NameStore NameLoad body If UnaryOpNot CompareIn NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list ClassDef bases body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad ListLoad body Expr Str Expr Call AttributeLoad NameLoad attr NameLoad For NameStore NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign AttributeStore NameLoad attr ListLoad If CompareEq NameLoad Str body Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr orelse If NameLoad body Assign AttributeStore NameLoad attr Call NameLoad NameLoad Str orelse Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults vararg body Expr Str For NameStore NameLoad body If UnaryOpNot CompareIn NameLoad AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If CompareIsNot AttributeLoad NameLoad attr NameLoad body Print AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body If AttributeLoad NameLoad attr body Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr orelse Assign NameStore NameLoad Return BinOpMod Str TupleLoad AttributeLoad AttributeLoad NameLoad attr attr NameLoad AttributeLoad NameLoad attr decorator_list decorator_list
N/A N/A 
Miscellaneous utilities for the documentation utilities.
 N/A __docformat__ reStructuredText N/A sys N/A os N/A os.path N/A warnings N/A unicodedata docutils ApplicationError DataError docutils nodes SystemMessage N/A ApplicationError N/A __init__ N/A N/A self system_message level N/A N/A N/A N/A N/A Exception __init__ self N/A N/A system_message astext N/A N/A self level level N/A N/A SystemMessagePropagation N/A ApplicationError N/A N/A N/A Reporter N/A N/A N/A 
    Info/warning/error reporter and ``system_message`` element generator.

    Five levels of system messages are defined, along with corresponding
    methods: `debug()`, `info()`, `warning()`, `error()`, and `severe()`.

    There is typically one Reporter object per process.  A Reporter object is
    instantiated with thresholds for reporting (generating warnings) and
    halting processing (raising exceptions), a switch to turn debug output on
    or off, and an I/O stream for warnings.  These are stored as instance
    attributes.

    When a system message is generated, its level is compared to the stored
    thresholds, and a warning or error is generated as appropriate.  Debug
    messages are produced iff the stored debug switch is on, independently of
    other thresholds.  Message output is sent to the stored warning stream if
    not set to ''.

    The Reporter class also employs a modified form of the "Observer" pattern
    [GoF95]_ to track system messages generated.  The `attach_observer` method
    should be called before parsing, with a bound method or function which
    accepts system messages.  The observer can be removed with
    `detach_observer`, and another added in its place.

    .. [GoF95] Gamma, Helm, Johnson, Vlissides. *Design Patterns: Elements of
       Reusable Object-Oriented Software*. Addison-Wesley, Reading, MA, USA,
       1995.
     N/A levels N/A N/A DEBUG INFO WARNING ERROR SEVERE split N/A List of names for system message levels, indexed by level. N/A N/A DEBUG_LEVEL INFO_LEVEL WARNING_LEVEL ERROR_LEVEL SEVERE_LEVEL N/A range 5 __init__ N/A N/A self source report_level halt_level stream debug encoding error_handler N/A None 0 ascii replace N/A N/A 
        :Parameters:
            - `source`: The path to or description of the source data.
            - `report_level`: The level at or above which warning output will
              be sent to `stream`.
            - `halt_level`: The level at or above which `SystemMessage`
              exceptions will be raised, halting execution.
            - `debug`: Show debug (level=0) system messages?
            - `stream`: Where warning output is sent.  Can be file-like (has a
              ``.write`` method), a string (file name, opened for writing),
              '' (empty string, for discarding all stream messages) or
              `None` (implies `sys.stderr`; default).
            - `encoding`: The encoding for stderr output.
            - `error_handler`: The error handler for stderr output encoding.
         N/A N/A self source source N/A The path to or description of the source data. N/A N/A self encoding encoding N/A The character encoding for the stderr output. N/A N/A self error_handler error_handler N/A The character encoding error handler. N/A N/A self debug_flag debug N/A Show debug (level=0) system messages? N/A N/A self report_level report_level N/A The level at or above which warning output will be sent
        to `self.stream`. N/A N/A self halt_level halt_level N/A The level at or above which `SystemMessage` exceptions
        will be raised, halting execution. N/A N/A stream None N/A N/A stream N/A sys stderr N/A N/A N/A N/A type stream N/A str unicode N/A N/A N/A stream N/A N/A N/A N/A type stream str N/A N/A stream N/A open stream w N/A N/A N/A N/A type stream unicode N/A N/A stream N/A open N/A N/A stream encode w N/A N/A self stream stream N/A Where warning output is sent. N/A N/A self observers N/A N/A List of bound methods or functions to call with each system_message
        created. N/A N/A self max_level -1 N/A The highest level system message generated so far. N/A set_conditions N/A N/A self category report_level halt_level stream debug N/A None 0 N/A N/A N/A N/A warnings warn docutils.utils.Reporter.set_conditions deprecated; set attributes via configuration settings or directly DeprecationWarning stacklevel 2 N/A N/A self report_level report_level N/A N/A self halt_level halt_level N/A N/A stream None N/A N/A stream N/A sys stderr N/A N/A self stream stream N/A N/A self debug_flag debug N/A attach_observer N/A N/A self observer N/A N/A N/A 
        The `observer` parameter is a function or bound method which takes one
        argument, a `nodes.system_message` instance.
         N/A N/A N/A N/A self observers append observer N/A detach_observer N/A N/A self observer N/A N/A N/A N/A N/A N/A self observers remove observer N/A notify_observers N/A N/A self message N/A N/A N/A observer N/A self observers N/A N/A N/A observer message N/A system_message N/A N/A self level message N/A children kwargs N/A N/A 
        Return a system_message object.

        Raise an exception or generate a warning if appropriate.
         N/A attributes N/A N/A kwargs copy N/A N/A base_node kwargs N/A N/A N/A source line N/A get_source_line N/A kwargs N/A base_node N/A N/A attributes N/A base_node N/A N/A source None N/A N/A N/A N/A attributes setdefault source source N/A N/A line None N/A N/A N/A N/A attributes setdefault line line N/A N/A N/A attributes setdefault source N/A self source N/A msg N/A N/A nodes system_message message level level type N/A N/A self levels N/A level children attributes N/A N/A N/A self stream N/A N/A level N/A self report_level N/A N/A self debug_flag N/A level N/A self DEBUG_LEVEL N/A N/A msgtext N/A N/A N/A N/A msg astext encode N/A self encoding N/A self error_handler N/A N/A self stream msgtext N/A N/A level N/A self halt_level N/A N/A N/A SystemMessage msg level N/A N/A N/A level N/A self DEBUG_LEVEL N/A self debug_flag N/A N/A N/A N/A self notify_observers msg N/A N/A self max_level N/A max level N/A self max_level N/A msg N/A debug N/A N/A self N/A args kwargs N/A N/A 
        Level-0, "DEBUG": an internal reporting issue. Typically, there is no
        effect on the processing. Level-0 system messages are handled
        separately from the others.
         N/A N/A self debug_flag N/A N/A N/A N/A self system_message N/A self DEBUG_LEVEL args kwargs N/A info N/A N/A self N/A args kwargs N/A N/A 
        Level-1, "INFO": a minor issue that can be ignored. Typically there is
        no effect on processing, and level-1 system messages are not reported.
         N/A N/A N/A self system_message N/A self INFO_LEVEL args kwargs N/A warning N/A N/A self N/A args kwargs N/A N/A 
        Level-2, "WARNING": an issue that should be addressed. If ignored,
        there may be unpredictable problems with the output.
         N/A N/A N/A self system_message N/A self WARNING_LEVEL args kwargs N/A error N/A N/A self N/A args kwargs N/A N/A 
        Level-3, "ERROR": an error that should be addressed. If ignored, the
        output will contain errors.
         N/A N/A N/A self system_message N/A self ERROR_LEVEL args kwargs N/A severe N/A N/A self N/A args kwargs N/A N/A 
        Level-4, "SEVERE": a severe error that must be addressed. If ignored,
        the output will contain severe errors. Typically level-4 system
        messages are turned into exceptions which halt processing.
         N/A N/A N/A self system_message N/A self SEVERE_LEVEL args kwargs N/A N/A ExtensionOptionError N/A DataError N/A N/A N/A BadOptionError N/A ExtensionOptionError N/A N/A N/A BadOptionDataError N/A ExtensionOptionError N/A N/A N/A DuplicateOptionError N/A ExtensionOptionError N/A N/A N/A extract_extension_options N/A N/A field_list options_spec N/A N/A N/A 
    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.).
     N/A option_list N/A extract_options field_list N/A option_dict N/A assemble_option_dict option_list options_spec N/A option_dict N/A extract_options N/A N/A field_list N/A N/A N/A 
    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.).
     N/A option_list N/A N/A field field_list N/A N/A N/A N/A len N/A N/A N/A N/A N/A field N/A 0 astext split 1 N/A N/A N/A BadOptionError extension option field name may not contain multiple words N/A name N/A str N/A N/A N/A N/A N/A field N/A 0 astext lower N/A body N/A field N/A 1 N/A N/A N/A len body 0 N/A N/A data None N/A N/A N/A N/A N/A len body 1 N/A N/A isinstance N/A body N/A 0 N/A nodes paragraph N/A N/A len N/A body N/A 0 1 N/A N/A isinstance N/A N/A body N/A 0 N/A 0 N/A nodes Text N/A N/A N/A BadOptionDataError N/A extension option field body may contain
a single paragraph only (option "%s") name N/A N/A data N/A N/A N/A N/A body N/A 0 N/A 0 astext N/A N/A N/A option_list append N/A name data N/A option_list N/A assemble_option_dict N/A N/A option_list options_spec N/A N/A N/A 
    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).
     N/A options N/A N/A N/A name value option_list N/A N/A convertor N/A options_spec N/A name N/A N/A convertor None N/A N/A N/A KeyError name N/A N/A name options N/A N/A N/A DuplicateOptionError N/A duplicate option "%s" name N/A N/A N/A N/A options N/A name N/A convertor value N/A N/A N/A N/A ValueError TypeError N/A detail N/A N/A N/A N/A detail __class__ N/A (option: "%s"; value: %r)
%s N/A name value N/A N/A join N/A detail args N/A options N/A NameValueError N/A DataError N/A N/A N/A extract_name_value N/A N/A line N/A N/A N/A 
    Return a list of (name, value) from a line of the form "name=value ...".

    :Exception:
        `NameValueError` for invalid input (missing name, missing data, bad
        quotes, etc.).
     N/A attlist N/A N/A line N/A N/A equals N/A N/A line find = N/A N/A equals -1 N/A N/A N/A NameValueError missing "=" N/A attname N/A N/A N/A line N/A equals strip N/A N/A N/A equals 0 N/A attname N/A N/A N/A NameValueError missing attribute name before "=" N/A line N/A N/A N/A line N/A N/A equals 1 lstrip N/A N/A line N/A N/A N/A NameValueError N/A missing value after "%s=" attname N/A N/A N/A line N/A 0 '" N/A N/A endquote N/A N/A line find N/A line N/A 0 1 N/A N/A endquote -1 N/A N/A N/A NameValueError N/A attribute "%s" missing end quote (%s) N/A attname N/A line N/A 0 N/A N/A N/A N/A len line N/A endquote 1 N/A N/A N/A line N/A N/A endquote 1 strip N/A N/A N/A NameValueError N/A attribute "%s" end quote (%s) not followed by whitespace N/A attname N/A line N/A 0 N/A data N/A line N/A 1 endquote N/A line N/A N/A N/A line N/A N/A endquote 1 lstrip N/A N/A space N/A N/A line find N/A N/A space -1 N/A N/A data line N/A line N/A N/A data N/A line N/A space N/A line N/A N/A N/A line N/A N/A space 1 lstrip N/A N/A N/A attlist append N/A N/A N/A attname lower data N/A attlist N/A new_reporter N/A N/A source_path settings N/A N/A N/A 
    Return a new Reporter object.

    :Parameters:
        `source` : string
            The path to or description of the source text of the document.
        `settings` : optparse.Values object
            Runtime settings.
     N/A reporter N/A Reporter source_path N/A settings report_level N/A settings halt_level stream N/A settings warning_stream debug N/A settings debug encoding N/A settings error_encoding error_handler N/A settings error_encoding_error_handler N/A reporter N/A new_document N/A N/A source_path settings N/A None N/A N/A 
    Return a new empty document object.

    :Parameters:
        `source_path` : string
            The path to or description of the source text of the document.
        `settings` : optparse.Values object
            Runtime settings.  If none provided, a default set will be used.
     docutils frontend N/A N/A settings None N/A N/A settings N/A N/A N/A N/A frontend OptionParser get_default_values N/A reporter N/A new_reporter source_path settings N/A document N/A N/A nodes document settings reporter source source_path N/A N/A N/A document note_source source_path -1 N/A document N/A clean_rcs_keywords N/A N/A paragraph keyword_substitutions N/A N/A N/A N/A N/A N/A len paragraph 1 N/A isinstance N/A paragraph N/A 0 N/A nodes Text N/A N/A textnode N/A paragraph N/A 0 N/A N/A pattern substitution keyword_substitutions N/A N/A match N/A N/A pattern search textnode N/A match N/A N/A N/A paragraph N/A 0 N/A N/A nodes Text N/A N/A pattern sub substitution textnode N/A N/A relative_path N/A N/A source target N/A N/A N/A 
    Build and return a path to `target`, relative to `source` (both files).

    If there is no common prefix, return the absolute path to `target`.
     N/A source_parts N/A N/A N/A N/A N/A os path abspath N/A source dummy_file split N/A os sep N/A target_parts N/A N/A N/A N/A N/A os path abspath target split N/A os sep N/A N/A N/A source_parts N/A 2 N/A target_parts N/A 2 N/A N/A N/A N/A / join target_parts N/A N/A N/A source_parts reverse N/A N/A N/A target_parts reverse N/A N/A source_parts target_parts N/A N/A source_parts N/A -1 N/A target_parts N/A -1 N/A N/A N/A N/A source_parts pop N/A N/A N/A target_parts pop N/A N/A N/A target_parts reverse N/A parts N/A N/A N/A .. N/A N/A len source_parts 1 target_parts N/A N/A N/A / join parts N/A get_stylesheet_reference N/A N/A settings relative_to N/A None N/A N/A 
    Retrieve stylesheet references from the settings object.

    Deprecated. Use get_stylesheet_reference_list() instead to
    enable specification of multiple stylesheets as a comma-separated
    list.
     N/A N/A settings stylesheet_path N/A N/A N/A N/A settings stylesheet stylesheet and stylesheet_path are mutually exclusive. N/A N/A relative_to None N/A N/A relative_to N/A settings _destination N/A N/A relative_path relative_to N/A settings stylesheet_path N/A N/A N/A settings stylesheet N/A get_stylesheet_list N/A N/A settings N/A N/A N/A 
    Retrieve list of stylesheet references from the settings object.
     N/A N/A settings stylesheet_path N/A N/A N/A N/A settings stylesheet stylesheet and stylesheet_path are mutually exclusive. N/A N/A N/A N/A settings stylesheet_path split , N/A N/A N/A settings stylesheet N/A N/A N/A N/A N/A settings stylesheet split , N/A N/A N/A N/A get_trim_footnote_ref_space N/A N/A settings N/A N/A N/A 
    Return whether or not to trim footnote space.

    If trim_footnote_reference_space is not None, return it.

    If trim_footnote_reference_space is None, return False unless the
    footnote reference style is 'superscript'.
     N/A N/A N/A settings trim_footnote_reference_space None N/A N/A N/A N/A hasattr settings footnote_references N/A N/A settings footnote_references superscript N/A N/A N/A settings trim_footnote_reference_space N/A get_source_line N/A N/A node N/A N/A N/A 
    Return the "source" and "line" attributes from the `node` given or from
    its closest ancestor.
     N/A node N/A N/A N/A N/A node source N/A node line N/A N/A N/A N/A node source N/A node line N/A node N/A node parent N/A N/A None None N/A escape2null N/A N/A text N/A N/A N/A Return a string with escape-backslashes converted to nulls. N/A parts N/A N/A start 0 N/A 1 N/A N/A found N/A N/A text find \ start N/A N/A found -1 N/A N/A N/A N/A parts append N/A text N/A start N/A N/A N/A join parts N/A N/A N/A parts append N/A text N/A start found N/A N/A N/A parts append N/A N/A text N/A N/A found 1 N/A found 2 N/A start N/A found 2 N/A unescape N/A N/A text restore_backslashes N/A 0 N/A N/A 
    Return a string with nulls removed or restored to backslashes.
    Backslash-escaped spaces are also removed.
     N/A restore_backslashes N/A N/A N/A N/A text replace \ N/A N/A sep N/A N/A N/A text N/A N/A join N/A N/A text split sep N/A text N/A N/A east_asian_widths N/A W F Na H N A 2 2 1 1 1 1 N/A Mapping of result codes from `unicodedata.east_asian_width()` to character
column widths. east_asian_column_width N/A N/A text N/A N/A N/A N/A isinstance text unicode N/A N/A total 0 N/A c text N/A N/A total N/A east_asian_widths N/A N/A N/A unicodedata east_asian_width c N/A total N/A N/A N/A len text N/A N/A N/A hasattr unicodedata east_asian_width N/A N/A column_width east_asian_column_width N/A N/A column_width len uniq N/A N/A L N/A N/A N/A r N/A N/A item L N/A N/A N/A N/A item r N/A N/A N/A N/A r append item N/A r N/A DependencyList N/A N/A N/A 
    List of dependencies, with file recording support.

    Note that the output file is not automatically closed.  You have
    to explicitly call the close() method.
     __init__ N/A N/A self output_file dependencies N/A None N/A N/A N/A 
        Initialize the dependency list, automatically setting the
        output file to `output_file` (see `set_output()`) and adding
        all supplied dependencies.
         N/A N/A N/A self set_output output_file N/A i dependencies N/A N/A N/A N/A self add i N/A set_output N/A N/A self output_file N/A N/A N/A 
        Set the output file and clear the list of already added
        dependencies.

        `output_file` must be a string.  The specified file is
        immediately overwritten.

        If output_file is '-', the output will be written to stdout.
        If it is None, no file output is done when calling add().
         N/A N/A self list N/A N/A N/A output_file - N/A N/A N/A self file N/A sys stdout N/A N/A output_file N/A N/A N/A self file N/A open output_file w N/A N/A N/A self file None N/A add N/A N/A self N/A filenames N/A N/A 
        If the dependency `filename` has not already been added,
        append it to self.list and print it to self.file if self.file
        is not None.
         N/A filename filenames N/A N/A N/A N/A filename N/A self list N/A N/A N/A N/A N/A self list append filename N/A N/A N/A self file None N/A N/A N/A self file filename N/A close N/A N/A self N/A N/A N/A 
        Close the output file.
         N/A N/A N/A N/A self file close N/A N/A self file None N/A __repr__ N/A N/A self N/A N/A N/A N/A self file N/A N/A output_file N/A N/A self file name N/A N/A output_file None N/A N/A %s(%r, %s) N/A N/A N/A self __class__ __name__ output_file N/A self list N/A N/A