sphinx.parsers.RSTParser

class documentation

class RSTParser(docutils.parsers.rst.Parser, Parser):

View In Hierarchy

A reST parser for Sphinx.
Method decorate Preprocess reST content before parsing.
Method get​_transforms Sphinx's reST parser replaces a transform class for smart-quotes by its own
Method parse Parse text and generate a document tree.
Instance Variable statemachine Undocumented

Inherited from Parser:

Method set​_application set_application will be called from Sphinx to set app and other instance variables
Instance Variable ​_app Undocumented
Instance Variable config Undocumented
Instance Variable env Undocumented
Property app Undocumented
def decorate(self, content):
Preprocess reST content before parsing.
Parameters
content:StringListUndocumented
def get_transforms(self):

Sphinx's reST parser replaces a transform class for smart-quotes by its own

refs: sphinx.io.SphinxStandaloneReader

Returns
List[Type[Transform]]Undocumented
def parse(self, inputstring, document):
Parse text and generate a document tree.
Parameters
inputstring:Union[str, StringList]Undocumented
document:nodes.documentUndocumented
statemachine =

Undocumented