Module Index

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. For custom behavior (setting component options), create custom component objects first, and pass ...
- examples - This module contains practical examples of Docutils client code.
- 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. Subclasses exist for a variety of input/output mechanisms.
- languages - This package contains modules for language-dependent features of Docutils.
  - af - Afrikaans-language mappings for language-dependent features of Docutils.
  - ar - Arabic-language mappings for language-dependent features of Docutils.
  - ca - Catalan-language mappings for language-dependent features of Docutils.
  - cs - Czech-language mappings for language-dependent features of Docutils.
  - da - Danish-language mappings 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.
  - eo - Esperanto-language mappings for language-dependent features of Docutils.
  - es - Spanish-language mappings for language-dependent features of Docutils.
  - fa - Persian-language mappings for language-dependent features of Docutils.
  - fi - Finnish-language mappings for language-dependent features of Docutils.
  - fr - French-language mappings for language-dependent features of Docutils.
  - gl - Galician-language mappings for language-dependent features of Docutils.
  - he - Hebrew-language mappings for language-dependent features of Docutils.
  - it - Italian-language mappings for language-dependent features of Docutils.
  - ja - Japanese-language mappings for language-dependent features of Docutils.
  - ko - Korean-language mappings for language-dependent features of Docutils.
  - lt - Lithuanian language mappings for language-dependent features of Docutils.
  - lv - Latvian-language mappings for language-dependent features of Docutils.
  - nl - Dutch-language mappings for language-dependent features of Docutils.
  - pl - Polish-language mappings for language-dependent features of Docutils.
  - pt_br - Brazilian Portuguese-language mappings for language-dependent features of Docutils.
  - ru - Russian-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.
  - zh_cn - Simplified Chinese language mappings for language-dependent features of Docutils.
  - zh_tw - Traditional Chinese language mappings for language-dependent features of Docutils.
- nodes - Docutils document tree element class library.
- parsers - This package contains Docutils parser modules.
  - null - A do-nothing parser.
  - recommonmark_wrapper - A parser for CommonMark MarkDown text using recommonmark.
  - rst - This is docutils.parsers.rst package. It exports a single class, Parser, the reStructuredText parser.
    - 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.
      - tables - Directives for table elements.
    - languages - This package contains modules for language-dependent features of reStructuredText.
      - af - Afrikaans-language mappings for language-dependent features of reStructuredText.
      - ar - Arabic-language mappings for language-dependent features of reStructuredText.
      - ca - Catalan-language mappings for language-dependent features of reStructuredText.
      - cs - Czech-language mappings for language-dependent features of reStructuredText.
      - da - Danish-language mappings 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.
      - eo - Esperanto-language mappings for language-dependent features of reStructuredText.
      - es - Spanish-language mappings for language-dependent features of reStructuredText.
      - fa - Persian-language mappings for language-dependent features of reStructuredText.
      - fi - Finnish-language mappings for language-dependent features of reStructuredText.
      - fr - French-language mappings for language-dependent features of reStructuredText.
      - gl - Galician-language mappings for language-dependent features of reStructuredText.
      - he - English-language mappings for language-dependent features of reStructuredText.
      - it - Italian-language mappings for language-dependent features of reStructuredText.
      - ja - Japanese-language mappings for language-dependent features of reStructuredText.
      - ko - Korean-language mappings for language-dependent features of reStructuredText.
      - lt - Lithuanian-language mappings for language-dependent features of reStructuredText.
      - lv - Latvian-language mappings for language-dependent features of reStructuredText.
      - nl - Dutch-language mappings for language-dependent features of reStructuredText.
      - pl - Polish-language mappings for language-dependent features of reStructuredText.
      - pt_br - Brazilian Portuguese-language mappings for language-dependent features of reStructuredText.
      - ru - Russian-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.
      - zh_cn - Simplified Chinese language mappings for language-dependent features of reStructuredText.
      - zh_tw - Traditional Chinese language mappings for language-dependent features of reStructuredText.
    - roles - This module defines standard interpreted text role functions, a registry for interpreted text roles, and an API for adding to and retrieving from the registry.
    - states - This is the docutils.parsers.rst.states module, the core of the reStructuredText parser. It defines the following:
    - 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.
  - doctree - Reader for existing document trees.
  - pep - Python Enhancement Proposal (PEP) Reader.
  - 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. Tree transforms serve a variety of purposes:
  - components - Docutils component-related transforms.
  - frontmatter - Transforms related to the front matter of a document or a section (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:
  - writer_aux - Auxiliary transforms mainly to be used by Writer components.
- utils - Miscellaneous utilities for the documentation utilities.
  - code_analyzer - Lexical analysis of formal languages (i.e. code) using Pygments.
  - error_reporting - Error reporting should be safe from encoding/decoding errors. However, implicit conversions of strings and exceptions like
  - math - This is the Docutils (Python Documentation Utilities) "math" sub-package.
    - latex2mathml - Convert LaTex math code into presentational MathML
    - math2html - No module docstring; 2/2 functions, 141/143 classes documented
    - tex2mathml_extern - No module docstring; 0/1 variable, 3/3 functions documented
    - tex2unichar - Undocumented
    - unichar2tex - Undocumented
  - punctuation_chars - No module docstring; 1/5 variable, 1/1 function documented
  - roman - Convert to and from Roman numerals
  - smartquotes - "SmartyPants" is a free web publishing plug-in for Movable Type, Blosxom, and BBEdit that easily translates plain ASCII punctuation characters into "smart" typographic punctuation characters.
  - urischemes - schemes is a dictionary with lowercase URI addressing schemes as keys and descriptions as values. It was compiled from the index at http://www.iana.org/assignments/uri-schemes (revised 2005-11-28) and an older list at ...
- writers - This package contains Docutils Writer modules.
  - docutils_xml - Simple document tree Writer, writes Docutils XML according to http://docutils.sourceforge.net/docs/ref/docutils.dtd.
  - html4css1 - Simple HyperText Markup Language document tree Writer.
  - html5_polyglot - Plain HyperText Markup Language document tree Writer.
  - latex2e - LaTeX2e document tree Writer.
  - manpage - Simple man page writer for reStructuredText.
  - null - A do-nothing Writer.
  - odf_odt - Open Document Format (ODF) Writer.
    - pygmentsformatter - Additional support for Pygments formatter.
  - pep_html - PEP HTML Writer.
  - pseudoxml - Simple internal document tree Writer, writes indented pseudo-XML.
  - s5_html - S5/HTML Slideshow Writer.
  - xetex - XeLaTeX document tree Writer.
  - _html_base - common definitions for Docutils HTML writers