# docutils - pydoc - phpman

Help on package docutils:

## NAME
    docutils - This is the Docutils (Python Documentation Utilities) package.

## DESCRIPTION
    Package Structure
    =================

    Modules:

    - __init__.py: Contains component base classes, exception classes, and
      Docutils version information.

    - core.py: Contains the ``Publisher`` class and ``publish_*()`` convenience
      functions.

    - frontend.py: Runtime settings (command-line interface, configuration files)
      processing, for Docutils front-ends.

    - io.py: Provides a uniform API for low-level input and output.

    - nodes.py: Docutils document tree (doctree) node class library.

    - statemachine.py: A finite state machine specialized for
      regular-expression-based text filters.

    Subpackages:

    - languages: Language-specific mappings of terms.

    - parsers: Syntax-specific input parser modules or packages.

    - readers: Context-specific input handlers which understand the data
      source and manage a parser.

    - transforms: Modules used by readers and writers to modify DPS
      doctrees.

    - utils: Contains the ``Reporter`` system warning class and miscellaneous
      utilities used by readers, writers, and transforms.

      utils/urischemes.py: Contains a complete mapping of known URI addressing
      scheme names to descriptions.

    - utils/math: Contains functions for conversion of mathematical notation
      between different formats (LaTeX, MathML, text, ...).

    - writers: Format-specific output translators.

## PACKAGE CONTENTS
    core
    examples
    frontend
    io
    languages (package)
    nodes
    parsers (package)
    readers (package)
    statemachine
    transforms (package)
    utils (package)
    writers (package)

## CLASSES
    builtins.Exception(builtins.BaseException)
        ApplicationError
            DataError
    builtins.object
        SettingsSpec
            Component(SettingsSpec, TransformSpec)
        TransformSpec
    VersionInfo(builtins.tuple)
        VersionInfo

### class ApplicationError
     |  Method resolution order:
     |      ApplicationError
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors defined here:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Exception:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

### class Component
     |  Base class for Docutils components.
     |
     |  Method resolution order:
     |      Component
     |      SettingsSpec
     |      TransformSpec
     |      builtins.object
     |
     |  Methods defined here:
     |
     |  supports(self, format)
     |      Is `format` supported by this component?
     |
     |      To be used by transforms to ask the dependent component if it supports
     |      a certain input context or output format.
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |
     |  component_type = None
     |
     |  supported = ()
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from SettingsSpec:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from SettingsSpec:
     |
     |  config_section = None
     |
     |  config_section_dependencies = None
     |
     |  relative_path_settings = ()
     |
     |  settings_default_overrides = None
     |
     |  settings_defaults = None
     |
     |  settings_spec = ()
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from TransformSpec:
     |
     |  get_transforms(self)
     |      Transforms required by this class.  Override in subclasses.
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from TransformSpec:
     |
     |  default_transforms = ()
     |
     |  unknown_reference_resolvers = ()

### class DataError
     |  Method resolution order:
     |      DataError
     |      ApplicationError
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors inherited from ApplicationError:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Exception:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

### class SettingsSpec
     |  Runtime setting specification base class.
     |
     |  SettingsSpec subclass objects used by `docutils.frontend.OptionParser`.
     |
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |
     |  config_section = None
     |
     |  config_section_dependencies = None
     |
     |  relative_path_settings = ()
     |
     |  settings_default_overrides = None
     |
     |  settings_defaults = None
     |
     |  settings_spec = ()

### class TransformSpec
     |  Runtime transform specification base class.
     |
     |  TransformSpec subclass objects used by `docutils.transforms.Transformer`.
     |
     |  Methods defined here:
     |
     |  get_transforms(self)
     |      Transforms required by this class.  Override in subclasses.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |
     |  default_transforms = ()
     |
     |  unknown_reference_resolvers = ()

### class VersionInfo
     |  VersionInfo(major=0, minor=0, micro=0, releaselevel='final', serial=0, release=True)
     |
     |  # from functools import total_ordering
     |  # @total_ordering
     |
     |  Method resolution order:
     |      VersionInfo
     |      VersionInfo
     |      builtins.tuple
     |      builtins.object
     |
     |  Methods defined here:
     |
     |  __ge__(self, other)
     |      Return self>=value.
     |
     |  __gt__(self, other)
     |      Return self>value.
     |
     |  __le__(self, other)
     |      Return self<=value.
     |
     |  __lt__(self, other)
     |      Return self<value.
     |
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |
     |  __new__(cls, major=0, minor=0, micro=0, releaselevel='final', serial=0, release=True)
     |      Create new instance of VersionInfo(major, minor, micro, releaselevel, serial, release)
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from VersionInfo:
     |
     |  __getnewargs__(self)
     |      Return self as a plain tuple.  Used by copy and pickle.
     |
     |  __repr__(self)
     |      Return a nicely formatted representation string
     |
     |  _asdict(self)
     |      Return a new dict which maps field names to their values.
     |
     |  _replace(self, /, **kwds)
     |      Return a new VersionInfo object replacing specified fields with new values
     |
     |  ----------------------------------------------------------------------
     |  Class methods inherited from VersionInfo:
     |
     |  _make(iterable) from builtins.type
     |      Make a new VersionInfo object from a sequence or iterable
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from VersionInfo:
     |
     |  major
     |      Alias for field number 0
     |
     |  minor
     |      Alias for field number 1
     |
     |  micro
     |      Alias for field number 2
     |
     |  releaselevel
     |      Alias for field number 3
     |
     |  serial
     |      Alias for field number 4
     |
     |  release
     |      Alias for field number 5
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from VersionInfo:
     |
     |  __match_args__ = ('major', 'minor', 'micro', 'releaselevel', 'serial',...
     |
     |  _field_defaults = {}
     |
     |  _fields = ('major', 'minor', 'micro', 'releaselevel', 'serial', 'relea...
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:
     |
     |  __add__(self, value, /)
     |      Return self+value.
     |
     |  __contains__(self, key, /)
     |      Return key in self.
     |
     |  __eq__(self, value, /)
     |      Return self==value.
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __getitem__(self, key, /)
     |      Return self[key].
     |
     |  __hash__(self, /)
     |      Return hash(self).
     |
     |  __iter__(self, /)
     |      Implement iter(self).
     |
     |  __len__(self, /)
     |      Return len(self).
     |
     |  __mul__(self, value, /)
     |      Return self*value.
     |
     |  __ne__(self, value, /)
     |      Return self!=value.
     |
     |  __rmul__(self, value, /)
     |      Return value*self.
     |
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |
     |      Raises ValueError if the value is not present.
     |
     |  ----------------------------------------------------------------------
     |  Class methods inherited from builtins.tuple:
     |
     |  __class_getitem__(...) from builtins.type
     |      See PEP 585

## DATA
    __docformat__ = 'reStructuredText'
    __version_details__ = 'release'
    __version_info__ = VersionInfo(major=0, minor=17, micro=1, releaseleve...

## VERSION
    0.17.1

## FILE
    /usr/lib/python3/dist-packages/docutils/__init__.py