pydoctor.templatewriter.IWriter

class documentation

class IWriter(Protocol): (source)

Known subclasses: pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

View In Hierarchy

Interface class for pydoctor output writer.

Method __init__ Undocumented
Method prepOutputDirectory Called first.
Method writeIndividualFiles Called last.
Method writeSummaryPages Called second.
def __init__(self, build_directory, template_lookup): (source)
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

Undocumented

Parameters
build_directory:PathUndocumented
template_lookup:TemplateLookupUndocumented
def prepOutputDirectory(self): (source)
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

Called first.

def writeIndividualFiles(self, obs): (source)
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

Called last.

Parameters
obs:Iterable[Documentable]Undocumented
def writeSummaryPages(self, system): (source)
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

Called second.

Parameters
system:SystemUndocumented