class documentation

class TemplateWriter(IWriter):

View In Hierarchy

HTML templates writer.
Class Method __subclasshook__ Undocumented
Method __init__
Method prep​Output​Directory Write static CSS and JS files to build directory.
Method write​Individual​Files Iterate through obs and call _writeDocsFor method for each Documentable.
Method write​Summary​Pages 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 _write​Docs​For Undocumented
Method _write​Docs​For​One Undocumented
@classmethod
def __subclasshook__(cls, subclass):

Undocumented

Parameters
subclass:Type[object]Undocumented
Returns
boolUndocumented
def __init__(self, build_directory, template_lookup):
Parameters
build​_directory:PathBuild directory.
template​_lookup:TemplateLookupTemplateLookup object.
def prepOutputDirectory(self):
Write static CSS and JS files to build directory.
def writeIndividualFiles(self, obs):
Iterate through obs and call _writeDocsFor method for each Documentable.
Parameters
obs:Iterable[model.Documentable]Undocumented
def writeSummaryPages(self, system):
Called second.
Parameters
system:model.SystemUndocumented
build_directory =
Build directory
dry_run: bool =

Undocumented

template_lookup: TemplateLookup =
Writer's TemplateLookup object
total_pages: int =

Undocumented

written_pages: int =

Undocumented

def _writeDocsFor(self, ob):

Undocumented

Parameters
ob:model.DocumentableUndocumented
def _writeDocsForOne(self, ob, fobj):

Undocumented

Parameters
ob:model.DocumentableUndocumented
fobj:IO[bytes]Undocumented