pydoctor.templatewriter.TemplateWriter

class documentation

class TemplateWriter(IWriter): (source)

HTML templates writer.

Class Method	`__subclasshook__`	Undocumented
Method	`__init__`	No summary
Method	`prepOutputDirectory`	Write static CSS and JS files to build directory.
Method	`writeIndividualFiles`	Iterate through `obs` and call `_writeDocsFor` method for each `Documentable`.
Method	`writeSummaryPages`	Called second.
Instance Variable	`build_directory`	Build directory
Instance Variable	`dry_run`	Undocumented
Instance Variable	`template_lookup`	Writer's `TemplateLookup` object
Instance Variable	`total_pages`	Undocumented
Instance Variable	`written_pages`	Undocumented
Method	`_writeDocsFor`	Undocumented
Method	`_writeDocsForOne`	Undocumented

Undocumented

def __init__(self, build_directory, template_lookup): (source) ¶

overrides pydoctor.templatewriter.IWriter.__init__

Parameters
build_directory:`Path`	Build directory.
template_lookup:`TemplateLookup`	`TemplateLookup` object.

overrides pydoctor.templatewriter.IWriter.prepOutputDirectory

Write static CSS and JS files to build directory.

def writeIndividualFiles(self, obs): (source) ¶

overrides pydoctor.templatewriter.IWriter.writeIndividualFiles

Iterate through obs and call _writeDocsFor method for each Documentable.

Parameters
obs:`Iterable[model.Documentable]`	Undocumented

def writeSummaryPages(self, system): (source) ¶

overrides pydoctor.templatewriter.IWriter.writeSummaryPages

Called second.

Parameters
system:`model.System`	Undocumented

Build directory

Undocumented

template_lookup: TemplateLookup = (source) ¶

Writer's TemplateLookup object

Undocumented

Undocumented

Undocumented

Parameters
ob:`model.Documentable`	Undocumented

def _writeDocsForOne(self, ob, fobj): (source) ¶

Undocumented