Home | Trees | Index | Help |
|
---|
|
docutils
: This is the Docutils (Python Documentation Utilities) package.
core
: Calling the publish_* convenience functions (or instantiating a
Publisher
object) with component names will result in default
behavior.
frontend
: Command-line and common processing for Docutils front-end tools.
io
: I/O classes provide a uniform API for low-level input and output.
languages
: This package contains modules for language-dependent features of Docutils.
de
: German language mappings for language-dependent features of Docutils.
en
: English-language mappings for language-dependent features of Docutils.
es
: Spanish-language mappings for language-dependent features of Docutils.
fr
: French-language mappings for language-dependent features of Docutils.
it
: Italian-language mappings for language-dependent features of Docutils.
sk
: Slovak-language mappings for language-dependent features of Docutils.
sv
: Swedish language mappings for language-dependent features of Docutils.
nodes
: Docutils document tree element class library.
parsers
: This package contains Docutils parser modules.
rst
: This is docutils.parsers.rst package.
directives
: This package contains directive implementation modules.
admonitions
: Admonition directives.
body
: Directives for additional body elements.
html
: Directives for typically HTML-specific constructs.
images
: Directives for figures and simple images.
misc
: Miscellaneous directives.
parts
: Directives for document parts.
references
: Directives for references and targets.
languages
: This package contains modules for language-dependent features of
reStructuredText.
de
: German-language mappings for language-dependent features of
reStructuredText.
en
: English-language mappings for language-dependent features of
reStructuredText.
es
: Spanish-language mappings for language-dependent features of
reStructuredText.
fr
: French-language mappings for language-dependent features of
reStructuredText.
it
: Italian-language mappings for language-dependent features of
reStructuredText.
sk
: Slovak-language mappings for language-dependent features of
reStructuredText.
sv
: Swedish language mappings for language-dependent features of reStructuredText.
states
: This is the docutils.parsers.restructuredtext.states module, the core of
the reStructuredText parser.
tableparser
: This module defines table parser classes,which parse plaintext-graphic tables
and produce a well-formed data structure suitable for building a CALS table.
readers
: This package contains Docutils Reader modules.
pep
: Python Enhancement Proposal (PEP) Reader.
python
: This package contains the Python Source Reader modules.
moduleparser
: Parser for Python modules.
standalone
: Standalone file Reader for the reStructuredText markup syntax.
statemachine
: A finite state machine specialized for regular-expression-based text filters,
this module defines the following classes:
transforms
: This package contains modules for standard tree transforms available
to Docutils components.
components
: Docutils component-related transforms.
frontmatter
: Transforms related to the front matter of a document (information
found before the main text):
misc
: Miscellaneous transforms.
parts
: Transforms related to document parts.
peps
: Transforms for PEP processing.
references
: Transforms for resolving references.
universal
: Transforms needed by most or all documents:
urischemes
: `schemes` is a dictionary with lowercase URI addressing schemes as
keys and descriptions as values.
utils
: Miscellaneous utilities for the documentation utilities.
writers
: This package contains Docutils Writer modules.
docutils_xml
: Simple internal document tree Writer, writes Docutils XML.
html4css1
: Simple HyperText Markup Language document tree Writer.
latex2e
: LaTeX2e document tree Writer.
pep_html
: PEP HTML Writer.
pseudoxml
: Simple internal document tree Writer, writes indented pseudo-XML.
ConfigParser.ConfigParser
UserString.UserString
docutils.nodes.Text
:
Instances are terminal nodes (leaves) containing text only; no child
nodes or attributes.
compiler.visitor.ASTVisitor
:
Performs a depth-first walk of the AST
The ASTVisitor will walk the AST, performing either a preorder or
postorder traversal depending on which method is called.
docutils.SettingsSpec
:
Runtime setting specification base class.
docutils.Component
:
Base class for Docutils components.
docutils.parsers.Parser
docutils.parsers.rst.Parser
:
The reStructuredText parser.
docutils.readers.Reader
:
Abstract base class for docutils Readers.
docutils.writers.Writer
:
Abstract base class for docutils Writers.
docutils.frontend.OptionParser
:
Parser for command-line and library use.
docutils.TransformSpec
:
Runtime transform specification base class.
docutils.Component
:
Base class for Docutils components.
docutils.parsers.Parser
docutils.parsers.rst.Parser
:
The reStructuredText parser.
docutils.readers.Reader
:
Abstract base class for docutils Readers.
docutils.writers.Writer
:
Abstract base class for docutils Writers.
docutils.io.Input
:
Abstract base class for input wrappers.
docutils.io.FileInput
:
Input for single, simple file-like objects.
docutils.io.NullInput
:
Degenerate input: read nothing.
docutils.io.StringInput
:
Direct string input.
docutils.io.Output
:
Abstract base class for output wrappers.
docutils.io.FileOutput
:
Output for single, simple file-like objects.
docutils.io.NullOutput
:
Degenerate output: write nothing.
docutils.io.StringOutput
:
Direct string output.
docutils.transforms.Transformer
:
Stores transforms (Transform
classes) and applies them to document
trees.
docutils.core.Publisher
:
A facade encapsulating the high-level logic of a Docutils system.
docutils.nodes.BackLinkable
docutils.nodes.Body
docutils.nodes.Admonition
docutils.nodes.General
docutils.nodes.Sequential
docutils.nodes.Special
:
Special internal body elements.
docutils.nodes.comment
docutils.parsers.rst.directives.html.meta
:
HTML-specific "meta" element.
docutils.nodes.pending
:
The "pending" element is used to encapsulate a pending operation: the
operation (transform), the point at which to apply it, and any data it
requires.
docutils.nodes.raw
:
Raw data that is to be passed untouched to the Writer.
docutils.nodes.substitution_definition
docutils.nodes.system_message
docutils.nodes.target
docutils.nodes.Decorative
docutils.nodes.Inline
docutils.nodes.abbreviation
docutils.nodes.acronym
docutils.nodes.citation_reference
docutils.nodes.emphasis
docutils.nodes.footnote_reference
docutils.nodes.generated
docutils.nodes.image
docutils.nodes.inline
docutils.nodes.literal
docutils.nodes.problematic
docutils.nodes.raw
:
Raw data that is to be passed untouched to the Writer.
docutils.nodes.reference
docutils.nodes.strong
docutils.nodes.subscript
docutils.nodes.substitution_reference
docutils.nodes.superscript
docutils.nodes.target
docutils.nodes.title_reference
docutils.nodes.Invisible
:
Internal elements that don't appear in output.
docutils.nodes.comment
docutils.nodes.pending
:
The "pending" element is used to encapsulate a pending operation: the
operation (transform), the point at which to apply it, and any data it
requires.
docutils.nodes.substitution_definition
docutils.nodes.target
docutils.nodes.Labeled
:
Contains a label
as its first element.
docutils.nodes.Node
:
Abstract base class of nodes in a document tree.
docutils.nodes.Element
:
Element
is the superclass to all specific elements.
docutils.nodes.admonition
docutils.nodes.attention
docutils.nodes.authors
docutils.nodes.block_quote
docutils.nodes.bullet_list
docutils.nodes.caution
docutils.nodes.citation
docutils.nodes.colspec
docutils.nodes.danger
docutils.nodes.decoration
docutils.nodes.definition
docutils.nodes.definition_list
docutils.nodes.definition_list_item
docutils.nodes.description
docutils.nodes.docinfo
docutils.nodes.document
docutils.nodes.entry
docutils.nodes.enumerated_list
docutils.nodes.error
docutils.nodes.field
docutils.nodes.field_body
docutils.nodes.field_list
docutils.nodes.figure
docutils.nodes.footer
docutils.nodes.footnote
docutils.nodes.header
docutils.nodes.hint
docutils.nodes.important
docutils.nodes.legend
docutils.nodes.list_item
docutils.parsers.rst.directives.html.meta
:
HTML-specific "meta" element.
docutils.nodes.note
docutils.nodes.option
docutils.nodes.option_group
docutils.nodes.option_list
docutils.nodes.option_list_item
docutils.nodes.pending
:
The "pending" element is used to encapsulate a pending operation: the
operation (transform), the point at which to apply it, and any data it
requires.
docutils.nodes.row
docutils.nodes.section
docutils.nodes.sidebar
:
Sidebars are like miniature, parallel documents that occur inside other
documents, providing related or reference material.
docutils.nodes.system_message
docutils.nodes.table
docutils.nodes.tbody
docutils.nodes.TextElement
:
An element which directly contains text.
docutils.nodes.abbreviation
docutils.nodes.acronym
docutils.nodes.attribution
docutils.nodes.author
docutils.nodes.caption
docutils.nodes.citation_reference
docutils.nodes.classifier
docutils.nodes.contact
docutils.nodes.copyright
docutils.nodes.date
docutils.nodes.emphasis
docutils.nodes.field_name
docutils.nodes.FixedTextElement
:
An element which directly contains preformatted text.
docutils.nodes.address
docutils.nodes.comment
docutils.nodes.doctest_block
docutils.nodes.line_block
docutils.nodes.literal_block
docutils.nodes.raw
:
Raw data that is to be passed untouched to the Writer.
docutils.nodes.footnote_reference
docutils.nodes.generated
docutils.nodes.image
docutils.nodes.inline
docutils.nodes.label
docutils.nodes.literal
docutils.nodes.option_argument
docutils.nodes.option_string
docutils.nodes.organization
docutils.nodes.paragraph
docutils.nodes.problematic
docutils.nodes.reference
docutils.nodes.revision
docutils.nodes.rubric
docutils.nodes.status
docutils.nodes.strong
docutils.nodes.subscript
docutils.nodes.substitution_definition
docutils.nodes.substitution_reference
docutils.nodes.subtitle
docutils.nodes.superscript
docutils.nodes.target
docutils.nodes.term
docutils.nodes.title
docutils.nodes.title_reference
docutils.nodes.version
docutils.nodes.tgroup
docutils.nodes.thead
docutils.nodes.tip
docutils.nodes.topic
:
Topics are terminal, "leaf" mini-sections, like block quotes with titles,
or textual figures.
docutils.nodes.transition
docutils.nodes.warning
docutils.nodes.Text
:
Instances are terminal nodes (leaves) containing text only; no child
nodes or attributes.
docutils.nodes.NodeVisitor
:
"Visitor" pattern [GoF95] abstract superclass implementation for document
tree traversals.
docutils.nodes.GenericNodeVisitor
:
Generic "Visitor" abstract superclass, for simple traversals.
docutils.transforms.universal.InternalAttributeExposer
docutils.writers.html4css1.SimpleListChecker
:
Raise nodes.SkipNode
if non-simple list item is encountered.
docutils.nodes.TreeCopyVisitor
:
Make a complete copy of a tree or branch, including element attributes.
docutils.writers.html4css1.HTMLTranslator
:
This HTML writer has been optimized to produce visually compact
lists (less vertical whitespace).
docutils.writers.latex2e.LaTeXTranslator
docutils.nodes.SparseNodeVisitor
:
Base class for sparse traversals, where only certain node types are of
interest.
docutils.transforms.references.ChainedTargetResolver
:
Copy reference attributes up the length of a hyperlink target chain.
docutils.transforms.universal.FinalCheckVisitor
docutils.transforms.peps.PEPZeroSpecial
:
Perform the special processing needed by PEP 0:
docutils.nodes.Part
docutils.nodes.attribution
docutils.nodes.caption
docutils.nodes.classifier
docutils.nodes.colspec
docutils.nodes.definition
docutils.nodes.definition_list_item
docutils.nodes.description
docutils.nodes.entry
docutils.nodes.field
docutils.nodes.field_body
docutils.nodes.field_name
docutils.nodes.label
docutils.nodes.legend
docutils.nodes.list_item
docutils.nodes.option
docutils.nodes.option_argument
docutils.nodes.option_group
docutils.nodes.option_list_item
docutils.nodes.option_string
docutils.nodes.row
docutils.nodes.tbody
docutils.nodes.term
docutils.nodes.tgroup
docutils.nodes.thead
docutils.nodes.PreDecorative
:
Category of Node which may occur before Decorative Nodes.
docutils.nodes.Bibliographic
docutils.nodes.PreBibliographic
:
Category of Node which may occur before Bibliographic Nodes.
docutils.nodes.comment
docutils.parsers.rst.directives.html.meta
:
HTML-specific "meta" element.
docutils.nodes.pending
:
The "pending" element is used to encapsulate a pending operation: the
operation (transform), the point at which to apply it, and any data it
requires.
docutils.nodes.raw
:
Raw data that is to be passed untouched to the Writer.
docutils.nodes.subtitle
docutils.nodes.system_message
docutils.nodes.title
docutils.nodes.Resolvable
docutils.nodes.Root
docutils.nodes.Structural
docutils.nodes.document
docutils.nodes.section
docutils.nodes.sidebar
:
Sidebars are like miniature, parallel documents that occur inside other
documents, providing related or reference material.
docutils.nodes.topic
:
Topics are terminal, "leaf" mini-sections, like block quotes with titles,
or textual figures.
docutils.nodes.transition
docutils.nodes.Titular
docutils.parsers.rst.states.Inliner
:
Parse inline markup; call the parse()
method.
docutils.readers.pep.Inliner
:
Extend rst.Inliner
for local PEP references.
docutils.parsers.rst.states.Struct
:
Stores data attributes for dotted-attribute access.
docutils.parsers.rst.tableparser.TableParser
:
Abstract superclass for the common parts of the syntax-specific parsers.
docutils.parsers.rst.tableparser.GridTableParser
:
Parse a grid table using parse()
.
docutils.parsers.rst.tableparser.SimpleTableParser
:
Parse a simple table using parse()
.
docutils.readers.python.moduleparser.Node
:
Base class for module documentation tree nodes.
docutils.readers.python.moduleparser.Attribute
docutils.readers.python.moduleparser.AttributeTuple
docutils.readers.python.moduleparser.Class
docutils.readers.python.moduleparser.Import
docutils.readers.python.moduleparser.Module
docutils.readers.python.moduleparser.ParameterList
docutils.readers.python.moduleparser.TextNode
docutils.readers.python.moduleparser.TokenParser
docutils.statemachine.State
:
State superclass.
docutils.statemachine.StateWS
:
State superclass specialized for whitespace (blank lines & indents).
docutils.parsers.rst.states.RSTState
:
reStructuredText State superclass.
docutils.parsers.rst.states.Body
:
Generic classifier of the first line of a block.
docutils.parsers.rst.states.RFC2822Body
:
RFC2822 headers are only valid as the first constructs in documents.
docutils.parsers.rst.states.RFC2822List
:
Second and subsequent RFC2822-style field_list fields.
docutils.parsers.rst.states.SpecializedBody
:
Superclass for second and subsequent compound element members.
docutils.parsers.rst.states.BulletList
:
Second and subsequent bullet_list list_items.
docutils.parsers.rst.states.DefinitionList
:
Second and subsequent definition_list_items.
docutils.parsers.rst.states.EnumeratedList
:
Second and subsequent enumerated_list list_items.
docutils.parsers.rst.states.Explicit
:
Second and subsequent explicit markup construct.
docutils.parsers.rst.states.FieldList
:
Second and subsequent field_list fields.
docutils.parsers.rst.states.ExtensionOptions
:
Parse field_list fields for extension options.
docutils.parsers.rst.directives.html.MetaBody
docutils.parsers.rst.states.OptionList
:
Second and subsequent option_list option_list_items.
docutils.parsers.rst.states.RFC2822List
:
Second and subsequent RFC2822-style field_list fields.
docutils.parsers.rst.states.SubstitutionDef
:
Parser for the contents of a substitution_definition element.
docutils.parsers.rst.states.Text
:
Classifier of second line of a text block.
docutils.parsers.rst.states.SpecializedText
:
Superclass for second and subsequent lines of Text-variants.
docutils.parsers.rst.states.Definition
:
Second line of potential definition_list_item.
docutils.parsers.rst.states.Line
:
Second line of over- & underlined section title or transition marker.
docutils.statemachine.StateMachine
:
A finite state machine for text filters using regular expressions.
docutils.statemachine.SearchStateMachine
:
StateMachine
which uses re.search()
instead of re.match()
.
docutils.statemachine.StateMachineWS
:
StateMachine
subclass specialized for whitespace recognition.
docutils.parsers.rst.states.NestedStateMachine
:
StateMachine run from within other StateMachine runs, to parse nested
document structures.
docutils.parsers.rst.states.RSTStateMachine
:
reStructuredText's master StateMachine.
docutils.statemachine.SearchStateMachineWS
:
StateMachineWS
which uses re.search()
instead of re.match()
.
docutils.statemachine.ViewList
:
List with extended functionality: slices of ViewList objects are child
lists, linked to their parents.
docutils.statemachine.StringList
:
A ViewList
with string-specific methods.
docutils.transforms.Transform
:
Docutils transform component abstract base class.
docutils.transforms.references.AnonymousHyperlinks
:
Link anonymous references to targets.
docutils.transforms.misc.CallBack
:
Inserts a callback into a document.
docutils.transforms.references.ChainedTargets
:
Attributes "refuri" and "refname" are migrated from the final direct
target up the chain of contiguous adjacent internal targets, using
ChainedTargetResolver
.
docutils.transforms.misc.ClassAttribute
docutils.transforms.parts.Contents
:
This transform generates a table of contents from the entire document tree
or from a single branch.
docutils.transforms.peps.Contents
:
Insert a table of contents transform placeholder into the document after
the RFC 2822 header.
docutils.transforms.universal.Decorations
:
Populate a document's decoration element (header, footer).
docutils.transforms.frontmatter.DocInfo
:
This transform is specific to the reStructuredText_ markup syntax;
see "Bibliographic Fields" in the `reStructuredText Markup
Specification`_ for a high-level description.
docutils.transforms.frontmatter.DocTitle
:
In reStructuredText_, there is no way to specify a document title
and subtitle explicitly.
docutils.transforms.references.ExternalTargets
:
Given:
docutils.transforms.components.Filter
:
Include or exclude elements which depend on a specific Docutils component.
docutils.transforms.universal.FinalChecks
:
Perform last-minute checks.
docutils.transforms.references.Footnotes
:
Assign numbers to autonumbered footnotes, and resolve links to footnotes,
citations, and their references.
docutils.transforms.peps.Headers
:
Process fields in a PEP's initial RFC-2822 header.
docutils.transforms.references.IndirectHyperlinks
:
Indirect external references:
docutils.transforms.references.InternalTargets
:
Given:
docutils.transforms.universal.Messages
:
Place any system messages generated after parsing into a dedicated section
of the document.
docutils.transforms.peps.PEPZero
:
Special processing for PEP 0.
docutils.transforms.parts.SectNum
:
Automatically assigns numbers to the titles of document sections.
docutils.transforms.references.Substitutions
:
Given the following document as input:
docutils.transforms.peps.TargetNotes
:
Locate the "References" section, insert a placeholder for an external
target footnote insertion transform at the end, and schedule the
transform to run immediately.
docutils.transforms.references.TargetNotes
:
Creates a footnote for each external target in the text, and corresponding
footnote references after each reference.
docutils.transforms.universal.TestMessages
:
Append all post-parse system messages to the end of the document.
docutils.utils.ConditionSet
:
A set of two thresholds (report_level
& halt_level
), a switch
(debug
), and an I/O stream (stream
), corresponding to one Reporter
category.
docutils.utils.Reporter
:
Info/warning/error reporter and system_message element generator.
docutils.writers.latex2e.Babel
:
Language specifics for LaTeX.
exceptions.Exception
:
Common base class for all exceptions.
docutils.parsers.rst.states.MarkupMismatch
exceptions.StandardError
:
Base class for all standard Python exceptions.
docutils.ApplicationError
docutils.DataError
docutils.parsers.rst.states.ParserError
docutils.utils.SystemMessage
docutils.transforms.TransformError
docutils.statemachine.StateCorrection
:
Raise from within a transition method to switch to another state.
docutils.statemachine.StateMachineError
docutils.statemachine.DuplicateStateError
docutils.statemachine.DuplicateTransitionError
docutils.statemachine.TransitionMethodNotFound
docutils.statemachine.TransitionPatternNotFound
docutils.statemachine.UnexpectedIndentationError
docutils.statemachine.UnknownStateError
docutils.statemachine.UnknownTransitionError
docutils.statemachine.TransitionCorrection
:
Raise from within a transition method to switch to another transition.
docutils.nodes.TreePruningException
:
Base class for NodeVisitor
-related tree pruning exceptions.
docutils.nodes.NodeFound
:
Raise to indicate that the target of a search has been found.
docutils.nodes.SkipChildren
:
Do not visit any children of the current node.
docutils.nodes.SkipDeparture
:
Do not call the current node's depart_... method.
docutils.nodes.SkipNode
:
Do not visit the current node's children, and do not call the current
node's depart_... method.
docutils.nodes.SkipSiblings
:
Do not visit any more siblings (to the right) of the current node.
optparse.OptionContainer
:
Abstract base class.
optparse.OptionParser
:
Class attributes:
standard_option_list : [Option]
list of standard options that will be accepted by all instances
of this parser class (intended to be overridden by subclasses).
docutils.frontend.OptionParser
:
Parser for command-line and library use.
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.0 on Tue Jul 22 05:32:00 2003 | http://epydoc.sf.net |