sphinx.io.SphinxStandaloneReader

class documentation

class SphinxStandaloneReader(SphinxBaseReader): (source)

View In Hierarchy

A basic document reader for Sphinx.

Method read Undocumented
Method read_source Read content from source and do post-process.
Method setup Undocumented
Instance Variable input Undocumented
Instance Variable parser Undocumented
Instance Variable settings Undocumented
Instance Variable source Undocumented
Instance Variable transforms Undocumented

Inherited from SphinxBaseReader:

Method __init__ Undocumented
Method get_transforms Undocumented
Method new_document Creates a new document object which has a special reporter object good for logging.
Instance Variable _app Undocumented
Instance Variable _env Undocumented
def read(self, source, parser, settings): (source)

Undocumented

Parameters
source:InputUndocumented
parser:ParserUndocumented
settings:ValuesUndocumented
Returns
nodes.documentUndocumented
def read_source(self, env): (source)

Read content from source and do post-process.

Parameters
env:BuildEnvironmentUndocumented
Returns
strUndocumented
def setup(self, app): (source)
overrides sphinx.io.SphinxBaseReader.setup

Undocumented

Parameters
app:SphinxUndocumented
input = (source)

Undocumented

parser = (source)

Undocumented

settings = (source)

Undocumented

source = (source)

Undocumented

transforms = (source)
overrides sphinx.io.SphinxBaseReader.transforms

Undocumented