pydoctor.test.InMemoryWriter

class documentation

class InMemoryWriter(IWriter): (source)

View In Hierarchy

Minimal template writer that doesn't touches the filesystem but will trigger the rendering of epydoc for the targeted code.

Method __init__ Undocumented
Method prepOutputDirectory Does nothing.
Method writeIndividualFiles Trigger in memory rendering for all objects.
Method writeSummaryPages Rig the system to not created the inter sphinx inventory.
Method _writeDocsFor Trigger in memory rendering of the object.
def __init__(self, build_directory, template_lookup): (source)
overrides pydoctor.templatewriter.IWriter.__init__

Undocumented

Parameters
build_directory:PathUndocumented
template_lookup:TemplateLookupUndocumented
def prepOutputDirectory(self): (source)
overrides pydoctor.templatewriter.IWriter.prepOutputDirectory

Does nothing.

def writeIndividualFiles(self, obs): (source)
overrides pydoctor.templatewriter.IWriter.writeIndividualFiles

Trigger in memory rendering for all objects.

Parameters
obs:Iterable[model.Documentable]Undocumented
def writeSummaryPages(self, system): (source)
overrides pydoctor.templatewriter.IWriter.writeSummaryPages

Rig the system to not created the inter sphinx inventory.

Parameters
system:model.SystemUndocumented
def _writeDocsFor(self, ob): (source)

Trigger in memory rendering of the object.

Parameters
ob:model.DocumentableUndocumented