sphinx.io.SphinxStandaloneReader

class documentation

class SphinxStandaloneReader(SphinxBaseReader):

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

Undocumented

Parameters
source:`Input`	Undocumented
parser:`Parser`	Undocumented
settings:`Values`	Undocumented
Returns
`nodes.document`	Undocumented

def read_source(self, env):

Read content from source and do post-process.

Parameters
env:`BuildEnvironment`	Undocumented
Returns
`str`	Undocumented

def setup(self, app):

overrides sphinx.io.SphinxBaseReader.setup

Undocumented

Parameters
app:`Sphinx`	Undocumented

input =

Undocumented

parser =

Undocumented

settings =

Undocumented

source =

Undocumented

transforms =

overrides sphinx.io.SphinxBaseReader.transforms

Undocumented