Package docutils
[show private | hide private]
[frames | no frames]

Package docutils

This is the Docutils (Python Documentation Utilities) package.

Package Structure

Modules:

Subpackages:


Submodules
  • 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.
    • 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.

Classes
Component Base class for Docutils components.
SettingsSpec Runtime setting specification base class.
TransformSpec Runtime transform specification base class.

Exceptions
ApplicationError  
DataError  

Variable Summary
str __version__ = '0.3.0'

Variable Details

__version__

Type:
str
Value:
'0.3.0'                                                                

Generated by Epydoc 2.0 on Tue Jul 22 05:31:28 2003 http://epydoc.sf.net