pydoctor.templatewriter.IWriter

class documentation

class IWriter(Protocol): (source)

Known subclasses: pydoctor.templatewriter.TemplateWriter

Constructor: IWriter(build_directory, template_lookup)

View In Hierarchy

Interface class for pydoctor output writer.

Method __init__ Undocumented
Method prepOutputDirectory Called first.
Method writeIndividualFiles Called third.
Method writeLinks Called after writeIndividualFiles when option --html-subject is not used.
Method writeSummaryPages Called second.
def __init__(self, build_directory: Path, template_lookup: TemplateLookup): (source)
overridden in pydoctor.templatewriter.TemplateWriter

Undocumented

def prepOutputDirectory(self): (source)
overridden in pydoctor.templatewriter.TemplateWriter

Called first.

def writeIndividualFiles(self, obs: Iterable[Documentable]): (source)
overridden in pydoctor.templatewriter.TemplateWriter

Called third.

def writeLinks(self, system: System): (source)
overridden in pydoctor.templatewriter.TemplateWriter

Called after writeIndividualFiles when option --html-subject is not used.

def writeSummaryPages(self, system: System): (source)
overridden in pydoctor.templatewriter.TemplateWriter

Called second.