sphinx.io.SphinxBaseReader

class documentation

class SphinxBaseReader(standalone.Reader): (source)

Known subclasses: sphinx.io.SphinxI18nReader, sphinx.io.SphinxStandaloneReader

View In Hierarchy

A base class of readers for Sphinx. This replaces reporter by Sphinx's on generating document.

Method __init__ Undocumented
Method get_transforms Undocumented
Method new_document Creates a new document object which has a special reporter object good for logging.
Method setup Undocumented
Class Variable transforms Undocumented
Instance Variable _app Undocumented
Instance Variable _env Undocumented
def __init__(self, *args, **kwargs): (source)

Undocumented

Parameters
*args:AnyUndocumented
**kwargs:AnyUndocumented
def get_transforms(self): (source)

Undocumented

Returns
list[type[Transform]]Undocumented
def new_document(self): (source)

Creates a new document object which has a special reporter object good for logging.

Returns
nodes.documentUndocumented
def setup(self, app): (source)
overridden in sphinx.io.SphinxI18nReader, sphinx.io.SphinxStandaloneReader

Undocumented

Parameters
app:SphinxUndocumented
transforms: list[type[Transform]] = (source)
overridden in sphinx.io.SphinxI18nReader, sphinx.io.SphinxStandaloneReader

Undocumented

_app = (source)

Undocumented

_env = (source)

Undocumented