pydoctor.test.InMemoryWriter

class documentation

class InMemoryWriter(IWriter):

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 prep​Output​Directory Does nothing.
Method write​Individual​Files Trigger in memory rendering for all objects.
Method write​Summary​Pages Rig the system to not created the inter sphinx inventory.
Method _write​Docs​For Trigger in memory rendering of the object.
def __init__(self, build_directory, template_lookup):
overrides pydoctor.templatewriter.IWriter.__init__

Undocumented

Parameters
build​_directory:PathUndocumented
template​_lookup:TemplateLookupUndocumented
def prepOutputDirectory(self):
overrides pydoctor.templatewriter.IWriter.prepOutputDirectory
Does nothing.
def writeIndividualFiles(self, obs):
overrides pydoctor.templatewriter.IWriter.writeIndividualFiles
Trigger in memory rendering for all objects.
Parameters
obs:Iterable[model.Documentable]Undocumented
def writeSummaryPages(self, system):
overrides pydoctor.templatewriter.IWriter.writeSummaryPages
Rig the system to not created the inter sphinx inventory.
Parameters
system:model.SystemUndocumented
def _writeDocsFor(self, ob):
Trigger in memory rendering of the object.
Parameters
ob:model.DocumentableUndocumented