pydoctor.templatewriter.IWriter

class documentation

class IWriter(Protocol):

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

View In Hierarchy

Interface class for pydoctor output writer.
Method __init__ Undocumented
Method prep​Output​Directory Called first.
Method write​Individual​Files Called last.
Method write​Summary​Pages Called second.
def __init__(self, build_directory, template_lookup):
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter

Undocumented

Parameters
build​_directory:PathUndocumented
template​_lookup:TemplateLookupUndocumented
def prepOutputDirectory(self):
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter
Called first.
def writeIndividualFiles(self, obs):
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter
Called last.
Parameters
obs:Iterable[Documentable]Undocumented
def writeSummaryPages(self, system):
overridden in pydoctor.templatewriter.TemplateWriter, pydoctor.test.InMemoryWriter
Called second.
Parameters
system:SystemUndocumented