sphinx.io.SphinxBaseReader

class documentation

class SphinxBaseReader(standalone.Reader):

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

Undocumented

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

Undocumented

Returns
List[Type[Transform]]Undocumented
def new_document(self):
Creates a new document object which has a special reporter object good for logging.
Returns
nodes.documentUndocumented
def setup(self, app):
overridden in sphinx.io.SphinxI18nReader, sphinx.io.SphinxStandaloneReader

Undocumented

Parameters
app:SphinxUndocumented
transforms: List[Type[Transform]] =
overridden in sphinx.io.SphinxI18nReader, sphinx.io.SphinxStandaloneReader

Undocumented

_app =

Undocumented

_env =

Undocumented