sphinx.parsers.RSTParser

class documentation

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

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 config Undocumented
Instance Variable env Undocumented
Instance Variable _app Undocumented
def decorate(self, content): (source)

Preprocess reST content before parsing.

Parameters
content:StringListUndocumented
def get_transforms(self): (source)

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): (source)

Parse text and generate a document tree.

Parameters
inputstring:str|StringListUndocumented
document:nodes.documentUndocumented
statemachine = (source)

Undocumented