Module Expr Str ImportFrom alias alias FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad Str NameLoad Num body Expr Str Assign NameStore Dict Str Str Str NameLoad NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword Str keyword NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad Str Str NameLoad Num body Expr Str Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Assign NameStore SubscriptLoad NameLoad Index Str If CompareNotEq NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad Str NameLoad body Expr Str If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr orelse Assign NameStore Dict Assign SubscriptStore NameLoad Index Str NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword Str keyword NameLoad keyword Str keyword NameLoad keyword Str keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Return TupleLoad AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list
N/A N/A 
This module contains practical examples of Docutils client code.

Importing this module from client code is not recommended; its contents are
subject to change in future Docutils releases.  Instead, it is recommended
that you copy and paste the parts you need into your own code, modifying as
necessary.
 docutils core io html_parts N/A N/A input_string source_path destination_path input_encoding doctitle initial_header_level N/A None None unicode True 1 N/A N/A 
    Given an input string, returns a dictionary of HTML document parts.

    Dictionary keys are the names of parts, and values are Unicode strings;
    encoding is up to the client.

    Parameters:

    - `input_string`: A multi-line text string; required.
    - `source_path`: Path to the source file or object.  Optional, but useful
      for diagnostic output (system messages).
    - `destination_path`: Path to the file or object which will receive the
      output; optional.  Used for determining relative paths (stylesheets,
      source links, etc.).
    - `input_encoding`: The encoding of `input_string`.  If it is an encoded
      8-bit string, provide the correct encoding.  If it is a Unicode string,
      use "unicode", the default.
    - `doctitle`: Disable the promotion of a lone top-level section title to
      document title (and subsequent section title to document subtitle
      promotion); enabled by default.
    - `initial_header_level`: The initial level for header elements (e.g. 1
      for "<h1>").
     N/A overrides N/A input_encoding doctitle_xform initial_header_level input_encoding doctitle initial_header_level N/A parts N/A N/A core publish_parts source input_string source_path source_path destination_path destination_path writer_name html settings_overrides overrides N/A parts N/A html_body N/A N/A input_string source_path destination_path input_encoding output_encoding doctitle initial_header_level N/A None None unicode unicode True 1 N/A N/A 
    Given an input string, returns an HTML fragment as a string.

    The return value is the contents of the <body> element.

    Parameters (see `html_parts()` for the remainder):

    - `output_encoding`: The desired encoding of the output.  If a Unicode
      string is desired, use the default value of "unicode" .
     N/A parts N/A html_parts input_string input_string source_path source_path destination_path destination_path input_encoding input_encoding doctitle doctitle initial_header_level initial_header_level N/A fragment N/A parts N/A html_body N/A N/A output_encoding unicode N/A N/A fragment N/A N/A fragment encode output_encoding N/A fragment N/A internals N/A N/A input_string source_path destination_path input_encoding settings_overrides N/A None None unicode None N/A N/A 
    Return the document tree and publisher, for exploring Docutils internals.

    Parameters: see `html_parts()`.
     N/A settings_overrides N/A N/A overrides N/A N/A settings_overrides copy N/A N/A overrides N/A N/A N/A overrides N/A input_encoding input_encoding N/A N/A output pub N/A N/A core publish_programmatically source_class N/A io StringInput source input_string source_path source_path destination_class N/A io NullOutput destination None destination_path destination_path reader None reader_name standalone parser None parser_name restructuredtext writer None writer_name null settings None settings_spec None settings_overrides overrides config_section None enable_exit_status None N/A N/A N/A N/A pub writer document pub N/A