nmk_doc.builders

Python module for nmk-doc plugin builders.

Classes

NmkDocSphinxBuilder

Builder used to trigger sphinx documentation build

Module Contents

class nmk_doc.builders.NmkDocSphinxBuilder(model: nmk.model.model.NmkModel)

Bases: nmk.model.builder.NmkTaskBuilder

Builder used to trigger sphinx documentation build

build(source_folder: str, output_folder: str)

Called by the doc.build task, to build the sphinx documentation

Parameters:

• source_folder – doc source folder

• output_folder – doc output folder