{
    "mode": "pydoc",
    "parameter": "docutils",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/pydoc/docutils/json",
    "generated": "2026-06-02T15:49:07Z",
    "sections": {
        "NAME": {
            "content": "docutils - This is the Docutils (Python Documentation Utilities) package.\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Package Structure\n=================\n\nModules:\n\n- init.py: Contains component base classes, exception classes, and\nDocutils version information.\n\n- core.py: Contains the ``Publisher`` class and ``publish*()`` convenience\nfunctions.\n\n- frontend.py: Runtime settings (command-line interface, configuration files)\nprocessing, for Docutils front-ends.\n\n- io.py: Provides a uniform API for low-level input and output.\n\n- nodes.py: Docutils document tree (doctree) node class library.\n\n- statemachine.py: A finite state machine specialized for\nregular-expression-based text filters.\n\nSubpackages:\n\n- languages: Language-specific mappings of terms.\n\n- parsers: Syntax-specific input parser modules or packages.\n\n- readers: Context-specific input handlers which understand the data\nsource and manage a parser.\n\n- transforms: Modules used by readers and writers to modify DPS\ndoctrees.\n\n- utils: Contains the ``Reporter`` system warning class and miscellaneous\nutilities used by readers, writers, and transforms.\n\nutils/urischemes.py: Contains a complete mapping of known URI addressing\nscheme names to descriptions.\n\n- utils/math: Contains functions for conversion of mathematical notation\nbetween different formats (LaTeX, MathML, text, ...).\n\n- writers: Format-specific output translators.\n",
            "subsections": []
        },
        "PACKAGE CONTENTS": {
            "content": "core\nexamples\nfrontend\nio\nlanguages (package)\nnodes\nparsers (package)\nreaders (package)\nstatemachine\ntransforms (package)\nutils (package)\nwriters (package)\n",
            "subsections": []
        },
        "CLASSES": {
            "content": "builtins.Exception(builtins.BaseException)\nApplicationError\nDataError\nbuiltins.object\nSettingsSpec\nComponent(SettingsSpec, TransformSpec)\nTransformSpec\nVersionInfo(builtins.tuple)\nVersionInfo\n",
            "subsections": [
                {
                    "name": "class ApplicationError",
                    "content": "|  Method resolution order:\n|      ApplicationError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class Component",
                    "content": "|  Base class for Docutils components.\n|\n|  Method resolution order:\n|      Component\n|      SettingsSpec\n|      TransformSpec\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  supports(self, format)\n|      Is `format` supported by this component?\n|\n|      To be used by transforms to ask the dependent component if it supports\n|      a certain input context or output format.\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  componenttype = None\n|\n|  supported = ()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from SettingsSpec:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from SettingsSpec:\n|\n|  configsection = None\n|\n|  configsectiondependencies = None\n|\n|  relativepathsettings = ()\n|\n|  settingsdefaultoverrides = None\n|\n|  settingsdefaults = None\n|\n|  settingsspec = ()\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from TransformSpec:\n|\n|  gettransforms(self)\n|      Transforms required by this class.  Override in subclasses.\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from TransformSpec:\n|\n|  defaulttransforms = ()\n|\n|  unknownreferenceresolvers = ()\n"
                },
                {
                    "name": "class DataError",
                    "content": "|  Method resolution order:\n|      DataError\n|      ApplicationError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from ApplicationError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class SettingsSpec",
                    "content": "|  Runtime setting specification base class.\n|\n|  SettingsSpec subclass objects used by `docutils.frontend.OptionParser`.\n|\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  configsection = None\n|\n|  configsectiondependencies = None\n|\n|  relativepathsettings = ()\n|\n|  settingsdefaultoverrides = None\n|\n|  settingsdefaults = None\n|\n|  settingsspec = ()\n"
                },
                {
                    "name": "class TransformSpec",
                    "content": "|  Runtime transform specification base class.\n|\n|  TransformSpec subclass objects used by `docutils.transforms.Transformer`.\n|\n|  Methods defined here:\n|\n|  gettransforms(self)\n|      Transforms required by this class.  Override in subclasses.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  defaulttransforms = ()\n|\n|  unknownreferenceresolvers = ()\n"
                },
                {
                    "name": "class VersionInfo",
                    "content": "|  VersionInfo(major=0, minor=0, micro=0, releaselevel='final', serial=0, release=True)\n|\n|  # from functools import totalordering\n|  # @totalordering\n|\n|  Method resolution order:\n|      VersionInfo\n|      VersionInfo\n|      builtins.tuple\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  ge(self, other)\n|      Return self>=value.\n|\n|  gt(self, other)\n|      Return self>value.\n|\n|  le(self, other)\n|      Return self<=value.\n|\n|  lt(self, other)\n|      Return self<value.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  new(cls, major=0, minor=0, micro=0, releaselevel='final', serial=0, release=True)\n|      Create new instance of VersionInfo(major, minor, micro, releaselevel, serial, release)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from VersionInfo:\n|\n|  getnewargs(self)\n|      Return self as a plain tuple.  Used by copy and pickle.\n|\n|  repr(self)\n|      Return a nicely formatted representation string\n|\n|  asdict(self)\n|      Return a new dict which maps field names to their values.\n|\n|  replace(self, /, kwds)\n|      Return a new VersionInfo object replacing specified fields with new values\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from VersionInfo:\n|\n|  make(iterable) from builtins.type\n|      Make a new VersionInfo object from a sequence or iterable\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from VersionInfo:\n|\n|  major\n|      Alias for field number 0\n|\n|  minor\n|      Alias for field number 1\n|\n|  micro\n|      Alias for field number 2\n|\n|  releaselevel\n|      Alias for field number 3\n|\n|  serial\n|      Alias for field number 4\n|\n|  release\n|      Alias for field number 5\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from VersionInfo:\n|\n|  matchargs = ('major', 'minor', 'micro', 'releaselevel', 'serial',...\n|\n|  fielddefaults = {}\n|\n|  fields = ('major', 'minor', 'micro', 'releaselevel', 'serial', 'relea...\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.tuple:\n|\n|  add(self, value, /)\n|      Return self+value.\n|\n|  contains(self, key, /)\n|      Return key in self.\n|\n|  eq(self, value, /)\n|      Return self==value.\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  getitem(self, key, /)\n|      Return self[key].\n|\n|  hash(self, /)\n|      Return hash(self).\n|\n|  iter(self, /)\n|      Implement iter(self).\n|\n|  len(self, /)\n|      Return len(self).\n|\n|  mul(self, value, /)\n|      Return self*value.\n|\n|  ne(self, value, /)\n|      Return self!=value.\n|\n|  rmul(self, value, /)\n|      Return value*self.\n|\n|  count(self, value, /)\n|      Return number of occurrences of value.\n|\n|  index(self, value, start=0, stop=9223372036854775807, /)\n|      Return first index of value.\n|\n|      Raises ValueError if the value is not present.\n|\n|  ----------------------------------------------------------------------\n|  Class methods inherited from builtins.tuple:\n|\n|  classgetitem(...) from builtins.type\n|      See PEP 585\n"
                }
            ]
        },
        "DATA": {
            "content": "docformat = 'reStructuredText'\nversiondetails = 'release'\nversioninfo = VersionInfo(major=0, minor=17, micro=1, releaseleve...\n",
            "subsections": []
        },
        "VERSION": {
            "content": "0.17.1\n",
            "subsections": []
        },
        "FILE": {
            "content": "/usr/lib/python3/dist-packages/docutils/init.py\n\n",
            "subsections": []
        }
    },
    "summary": "docutils - This is the Docutils (Python Documentation Utilities) package.",
    "flags": [],
    "examples": [],
    "see_also": []
}