sphinx.parsers.Parser

class documentation

class Parser(docutils.parsers.Parser): (source)

Known subclasses: sphinx.parsers.RSTParser

A base class of source parsers. The additional parsers should inherit this class instead of ``docutils.parsers.Parser``. Compared with ``docutils.parsers.Parser``, this class improves accessibility to Sphinx APIs. The subclasses can access sphinx core runtime objects (app, config and env).

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 set_application(self, app): (source) ¶

set_application will be called from Sphinx to set app and other instance variables :param sphinx.application.Sphinx app: Sphinx application object

Parameters
app:`Sphinx`	Undocumented

config = (source) ¶

Undocumented

env = (source) ¶

Undocumented

_app = (source) ¶

Undocumented