pydoctor.templatewriter.TemplateWriter

Modules Classes Names

class documentation

class TemplateWriter(IWriter): (source)

Constructor: TemplateWriter(build_directory, template_lookup)

View In Hierarchy

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	`writeLinks`	Called after writeIndividualFiles when option --html-subject is not used.
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

def __subclasshook__(cls, subclass: type[object]) -> bool: (source) ¶

Undocumented

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

overrides pydoctor.templatewriter.IWriter.__init__

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

def prepOutputDirectory(self): (source) ¶

overrides pydoctor.templatewriter.IWriter.prepOutputDirectory

Write static CSS and JS files to build directory.

def writeIndividualFiles(self, obs: Iterable[model.Documentable]): (source) ¶

overrides pydoctor.templatewriter.IWriter.writeIndividualFiles

Iterate through obs and call _writeDocsFor method for each Documentable.

def writeLinks(self, system: model.System): (source) ¶

overrides pydoctor.templatewriter.IWriter.writeLinks

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

def writeSummaryPages(self, system: model.System): (source) ¶

overrides pydoctor.templatewriter.IWriter.writeSummaryPages

Called second.

build_directory = (source) ¶

Build directory

dry_run: bool = (source) ¶

Undocumented

template_lookup: TemplateLookup = (source) ¶

Writer's TemplateLookup object

total_pages: int = (source) ¶

Undocumented

written_pages: int = (source) ¶

Undocumented

def _writeDocsFor(self, ob: model.Documentable): (source) ¶

Undocumented

def _writeDocsForOne(self, ob: model.Documentable, fobj: IO[bytes]): (source) ¶

Undocumented