Module Expr Str Assign NameStore Str Import alias Import alias Import alias ImportFrom alias ImportFrom alias identifier If CompareLt AttributeLoad NameLoad attr TupleLoad Num Num body ImportFrom alias Assign NameStore Dict Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str Expr Str Assign NameStore Dict Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore ListLoad Assign NameStore ListLoad If CompareIn NameLoad NameLoad body Return TupleLoad SubscriptLoad NameLoad Index NameLoad NameLoad Assign NameStore NameLoad TryExcept body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index NameLoad handlers ExceptHandler type NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr BinOpMod Str TupleLoad NameLoad NameLoad ExceptHandler type NameLoad body Expr Call AttributeLoad NameLoad attr BinOpMod Str TupleLoad NameLoad AttributeLoad NameLoad attr If UnaryOpNot NameLoad body TryExcept body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Expr Call AttributeLoad NameLoad attr BinOpMod Str NameLoad handlers ExceptHandler type NameLoad body Expr Call AttributeLoad NameLoad attr BinOpMod Str NameLoad Assign NameStore NameLoad If NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad Str attr NameLoad keyword AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad TryExcept body Assign TupleStore NameStore NameStore SubscriptLoad NameLoad Index NameLoad handlers ExceptHandler type NameLoad body Return TupleLoad NameLoad NameLoad TryExcept body Assign NameStore Call NameLoad NameLoad Call NameLoad Call NameLoad keyword Num handlers ExceptHandler type NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr BinOpMod Str TupleLoad NameLoad NameLoad NameLoad keyword AttributeLoad NameLoad attr Return TupleLoad NameLoad NameLoad TryExcept body Assign NameStore Call NameLoad NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad handlers ExceptHandler type NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr BinOpMod Str TupleLoad NameLoad NameLoad NameLoad keyword AttributeLoad NameLoad attr Return TupleLoad NameLoad NameLoad Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign SubscriptStore NameLoad Index NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If BoolOpAnd NameLoad Call AttributeLoad NameLoad attr body Raise Call NameLoad BinOpMod Str NameLoad orelse Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str orelse Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Return Str orelse Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str orelse Assign NameStore Call AttributeLoad Str attr ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str orelse Assign NameStore Call AttributeLoad Str attr Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad NameLoad If CompareLt NameLoad Num body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr Str handlers ExceptHandler type NameLoad body Pass Return Call NameLoad NameLoad decorator_list Assign NameStore ListLoad Str Str Str Str Str Str Str Str FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr BinOpMod Str Call AttributeLoad Str attr NameLoad NameLoad TryExcept body Expr Call NameLoad Call AttributeLoad NameLoad attr Num handlers ExceptHandler type TupleLoad NameLoad NameLoad body Raise Call NameLoad BinOpMod Str Call AttributeLoad Str attr ListComp BinOpMod Str NameLoad comprehension NameStore NameLoad Return BinOpAdd Call AttributeLoad NameLoad attr Num Call AttributeLoad NameLoad attr Num decorator_list FunctionDef arguments args NameParam defaults body Return Call NameLoad NameLoad BinOpAdd NameLoad ListLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str TryExcept body Return Call NameLoad NameLoad BinOpAdd NameLoad ListLoad Str handlers ExceptHandler type NameLoad body TryExcept body Return BinOpAdd Call NameLoad NameLoad ListLoad Str NameLoad handlers ExceptHandler type NameLoad body Return Call NameLoad NameLoad BinOpAdd NameLoad ListLoad Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore ListLoad For NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad If UnaryOpNot NameLoad body Raise Call NameLoad BinOpMod Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list Assign NameStore Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str TryExcept body If Call AttributeLoad NameLoad attr body Return Call NameLoad Call NameLoad NameLoad orelse Assign NameStore Call AttributeLoad NameLoad attr NameLoad If NameLoad body Assign NameStore BoolOpOr Call AttributeLoad NameLoad attr Num Call AttributeLoad NameLoad attr Num Return Call NameLoad Call NameLoad NameLoad Num orelse Return NameLoad handlers ExceptHandler type NameLoad name NameStore body Raise Call NameLoad BinOpMod Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad NameLoad If CompareGt Call NameLoad NameLoad Num body Raise Call NameLoad BinOpMod Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareEq NameLoad Str body Assign NameStore Str orelse If CompareEq NameLoad Str body Assign NameStore Str orelse Assign NameStore Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad NameLoad If CompareLt NameLoad Num body Raise Call NameLoad Str Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIn Str NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Str orelse Assign NameStore Call AttributeLoad NameLoad attr Return ListComp Call NameLoad NameLoad comprehension NameStore NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str TryExcept body Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad body Raise Call NameLoad BinOpMod Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr handlers ExceptHandler type NameLoad body Raise Call NameLoad BinOpMod Str Call NameLoad NameLoad If CompareIn NameLoad NameLoad body Return NameLoad orelse Raise Call NameLoad BinOpMod Str TupleLoad NameLoad Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return BinOpMod Str TupleLoad Call AttributeLoad Str attr ListComp BinOpMod Str NameLoad comprehension NameStore SubscriptLoad NameLoad Slice Num SubscriptLoad NameLoad Index Num decorator_list
N/A N/A 
This package contains directive implementation modules.
 N/A __docformat__ reStructuredText N/A re N/A codecs N/A sys docutils nodes docutils.parsers.rst.languages en _fallback_language_module N/A N/A N/A sys version_info N/A 2 5 N/A docutils._compat __import__ N/A _directive_registry N/A attention caution code danger error important note tip hint warning admonition sidebar topic line-block parsed-literal math rubric epigraph highlights pull-quote compound container table csv-table list-table image figure contents sectnum header footer target-notes meta raw include replace unicode class role default-role title date restructuredtext-test-directive N/A admonitions Attention N/A admonitions Caution N/A body CodeBlock N/A admonitions Danger N/A admonitions Error N/A admonitions Important N/A admonitions Note N/A admonitions Tip N/A admonitions Hint N/A admonitions Warning N/A admonitions Admonition N/A body Sidebar N/A body Topic N/A body LineBlock N/A body ParsedLiteral N/A body MathBlock N/A body Rubric N/A body Epigraph N/A body Highlights N/A body PullQuote N/A body Compound N/A body Container N/A tables RSTTable N/A tables CSVTable N/A tables ListTable N/A images Image N/A images Figure N/A parts Contents N/A parts Sectnum N/A parts Header N/A parts Footer N/A references TargetNotes N/A html Meta N/A misc Raw N/A misc Include N/A misc Replace N/A misc Unicode N/A misc Class N/A misc Role N/A misc DefaultRole N/A misc Title N/A misc Date N/A misc TestDirective N/A Mapping of directive name to (module name, class name).  The
directive name is canonical & must be lowercase.  Language-dependent
names are defined in the ``language`` subpackage. N/A _directives N/A N/A Cache of imported directives. directive N/A N/A directive_name language_module document N/A N/A N/A 
    Locate and return a directive function from its language-dependent name.
    If not found in the current language, check English.  Return None if the
    named directive cannot be found.
     N/A normname N/A N/A directive_name lower N/A messages N/A N/A msg_text N/A N/A N/A normname _directives N/A N/A N/A N/A _directives N/A normname messages N/A canonicalname None N/A N/A N/A canonicalname N/A N/A language_module directives N/A normname N/A N/A N/A AttributeError N/A error N/A N/A N/A N/A msg_text append N/A Problem retrieving directive entry from language module %r: %s. N/A language_module error N/A N/A KeyError N/A N/A N/A N/A msg_text append N/A No directive entry for "%s" in module "%s". N/A directive_name N/A language_module __name__ N/A N/A canonicalname N/A N/A N/A N/A canonicalname N/A N/A _fallback_language_module directives N/A normname N/A N/A N/A msg_text append N/A Using English fallback for directive "%s". directive_name N/A N/A N/A KeyError N/A N/A N/A N/A msg_text append N/A Trying "%s" as canonical directive name. directive_name N/A canonicalname normname N/A msg_text N/A N/A message N/A N/A N/A document reporter info N/A N/A join msg_text line N/A document current_line N/A N/A N/A messages append message N/A N/A N/A N/A modulename classname N/A _directive_registry N/A canonicalname N/A N/A N/A KeyError N/A N/A N/A None messages N/A N/A N/A module N/A __import__ modulename N/A globals N/A locals level 1 N/A N/A N/A ImportError N/A detail N/A N/A N/A N/A messages append N/A N/A N/A document reporter error N/A Error importing directive module "%s" (directive "%s"):
%s N/A modulename directive_name detail line N/A document current_line N/A N/A None messages N/A N/A N/A directive N/A getattr module classname N/A N/A _directives N/A normname directive N/A N/A N/A AttributeError N/A N/A N/A N/A messages append N/A N/A N/A document reporter error N/A No directive class "%s" in module "%s" (directive "%s"). N/A classname modulename directive_name line N/A document current_line N/A N/A None messages N/A N/A directive messages N/A register_directive N/A N/A name directive N/A N/A N/A 
    Register a nonstandard application-defined directive function.
    Language lookups are not needed for such functions.
     N/A N/A _directives N/A name directive N/A flag N/A N/A argument N/A N/A N/A 
    Check for a valid flag option (no argument) and return ``None``.
    (Directive option conversion function.)

    Raise ``ValueError`` if an argument is found.
     N/A N/A argument N/A N/A argument strip N/A N/A N/A ValueError N/A no argument is allowed; "%s" supplied argument N/A N/A None N/A unchanged_required N/A N/A argument N/A N/A N/A 
    Return the argument text, unchanged.
    (Directive option conversion function.)

    Raise ``ValueError`` if no argument is found.
     N/A N/A argument None N/A N/A N/A ValueError argument required but none supplied N/A N/A argument N/A unchanged N/A N/A argument N/A N/A N/A 
    Return the argument text, unchanged.
    (Directive option conversion function.)

    No argument implies empty string ("").
     N/A N/A argument None N/A N/A N/A N/A argument N/A path N/A N/A argument N/A N/A N/A 
    Return the path argument unwrapped (with newlines removed).
    (Directive option conversion function.)

    Raise ``ValueError`` if no argument is found.
     N/A N/A argument None N/A N/A N/A ValueError argument required but none supplied N/A N/A path N/A N/A join N/A N/A N/A s strip N/A s N/A N/A argument splitlines N/A path N/A uri N/A N/A argument N/A N/A N/A 
    Return the URI argument with whitespace removed.
    (Directive option conversion function.)

    Raise ``ValueError`` if no argument is found.
     N/A N/A argument None N/A N/A N/A ValueError argument required but none supplied N/A N/A uri N/A N/A join N/A N/A argument split N/A uri N/A nonnegative_int N/A N/A argument N/A N/A N/A 
    Check for a nonnegative integer argument; raise ``ValueError`` if not.
    (Directive option conversion function.)
     N/A value N/A int argument N/A N/A value 0 N/A N/A N/A ValueError negative value; must be positive or zero N/A value N/A percentage N/A N/A argument N/A N/A N/A 
    Check for an integer percentage value with optional percent sign.
     N/A N/A N/A argument N/A N/A argument rstrip  % N/A N/A N/A AttributeError N/A N/A N/A N/A nonnegative_int argument N/A N/A length_units N/A em ex px in cm mm pt pc get_measure N/A N/A argument units N/A N/A N/A 
    Check for a positive argument of one of the units and return a
    normalized string of the form "<value><unit>" (without space in
    between).

    To be called from directive option conversion functions.
     N/A match N/A N/A re match N/A ^([0-9.]+) *(%s)$ N/A N/A | join units argument N/A N/A N/A N/A float N/A N/A match group 1 N/A N/A N/A N/A AttributeError ValueError N/A N/A N/A ValueError N/A not a positive measure of one of the following units:
%s N/A N/A join N/A N/A "%s" i N/A i units N/A N/A N/A N/A match group 1 N/A N/A match group 2 N/A length_or_unitless N/A N/A argument N/A N/A N/A N/A get_measure argument N/A length_units N/A N/A length_or_percentage_or_unitless N/A N/A argument default N/A N/A N/A 
    Return normalized string of a length or percentage unit.

    Add <default> if there is no unit. Raise ValueError if the argument is not
    a positive measure of one of the valid CSS units (or without unit).

    >>> length_or_percentage_or_unitless('3 pt')
    '3pt'
    >>> length_or_percentage_or_unitless('3%', 'em')
    '3%'
    >>> length_or_percentage_or_unitless('3')
    '3'
    >>> length_or_percentage_or_unitless('3', 'px')
    '3px'
     N/A N/A N/A N/A get_measure argument N/A length_units N/A % N/A N/A N/A ValueError N/A N/A N/A N/A N/A N/A get_measure argument N/A default N/A N/A N/A ValueError N/A N/A N/A get_measure argument N/A length_units N/A % N/A class_option N/A N/A argument N/A N/A N/A 
    Convert the argument into a list of ID-compatible strings and return it.
    (Directive option conversion function.)

    Raise ``ValueError`` if no argument is found.
     N/A N/A argument None N/A N/A N/A ValueError argument required but none supplied N/A names N/A N/A argument split N/A class_names N/A N/A name names N/A N/A class_name N/A N/A nodes make_id name N/A N/A class_name N/A N/A N/A ValueError N/A cannot make "%s" into a class name name N/A N/A N/A class_names append class_name N/A class_names N/A N/A unicode_pattern N/A N/A re compile (?:0x|x|\\x|U\+?|\\u)([0-9a-f]+)$|&#x([0-9a-f]+);$ N/A re IGNORECASE unicode_code N/A N/A code N/A N/A N/A 
    Convert a Unicode character code to a Unicode character.
    (Directive option conversion function.)

    Codes may be decimal numbers, hexadecimal numbers (prefixed by ``0x``,
    ``x``, ``\x``, ``U+``, ``u``, or ``\u``; e.g. ``U+262E``), or XML-style
    numeric character entities (e.g. ``&#x262E;``).  Other text remains as-is.

    Raise ValueError for illegal Unicode code values.
     N/A N/A N/A N/A N/A code isdigit N/A N/A N/A unichr N/A int code N/A N/A match N/A N/A unicode_pattern match code N/A match N/A N/A value N/A N/A N/A match group 1 N/A N/A match group 2 N/A N/A unichr N/A int value 16 N/A N/A code N/A N/A N/A OverflowError N/A detail N/A N/A N/A ValueError N/A code too large (%s) detail N/A single_char_or_unicode N/A N/A argument N/A N/A N/A 
    A single character is returned as-is.  Unicode characters codes are
    converted as in `unicode_code`.  (Directive option conversion function.)
     N/A char N/A unicode_code argument N/A N/A N/A len char 1 N/A N/A N/A ValueError N/A %r invalid; must be a single character or a Unicode code char N/A char N/A single_char_or_whitespace_or_unicode N/A N/A argument N/A N/A N/A 
    As with `single_char_or_unicode`, but "tab" and "space" are also supported.
    (Directive option conversion function.)
     N/A N/A argument tab N/A N/A char N/A N/A N/A argument space N/A N/A char N/A N/A char N/A single_char_or_unicode argument N/A char N/A positive_int N/A N/A argument N/A N/A N/A 
    Converts the argument into an integer.  Raises ValueError for negative,
    zero, or non-integer values.  (Directive option conversion function.)
     N/A value N/A int argument N/A N/A value 1 N/A N/A N/A ValueError negative or zero value; must be positive N/A value N/A positive_int_list N/A N/A argument N/A N/A N/A 
    Converts a space- or comma-separated list of values into a Python list
    of integers.
    (Directive option conversion function.)

    Raises ValueError for non-positive-integer values.
     N/A N/A , argument N/A N/A entries N/A N/A argument split , N/A N/A entries N/A N/A argument split N/A N/A N/A positive_int entry N/A entry entries N/A encoding N/A N/A argument N/A N/A N/A 
    Verfies the encoding argument by lookup.
    (Directive option conversion function.)

    Raises ValueError for unknown encodings.
     N/A N/A N/A N/A N/A codecs lookup argument N/A N/A N/A LookupError N/A N/A N/A ValueError N/A unknown encoding: "%s" argument N/A argument N/A choice N/A N/A argument values N/A N/A N/A 
    Directive option utility function, supplied to enable options whose
    argument must be a member of a finite set of possible values (must be
    lower case).  A custom conversion function must be written to use it.  For
    example::

        from docutils.parsers.rst import directives

        def yesno(argument):
            return directives.choice(argument, ('yes', 'no'))

    Raise ``ValueError`` if no argument is found or if the argument's value is
    not valid (not an entry in the supplied list).
     N/A N/A N/A value N/A N/A N/A N/A argument lower strip N/A N/A N/A AttributeError N/A N/A N/A ValueError N/A must supply an argument; choose from %s N/A format_values values N/A N/A value values N/A N/A value N/A N/A N/A ValueError N/A "%s" unknown; choose from %s N/A argument N/A format_values values N/A format_values N/A N/A values N/A N/A N/A N/A %s, or "%s" N/A N/A N/A ,  join N/A N/A "%s" s N/A s N/A values N/A -1 N/A values N/A -1 N/A