`nmk_doc.builders`

Python module for nmk-doc plugin builders.

Module Contents

`NmkDocConfigBuilder`	Builder used to generate the sphinx config file
`NmkDocSphinxBuilder`	Builder used to trigger sphinx documentation build

class nmk_doc.builders.NmkDocConfigBuilder(model: nmk.model.model.NmkModel)

Bases: nmk_base.common.TemplateBuilder

Builder used to generate the sphinx config file

build(template: str)

Called by the doc.config task, to generate the sphinx config file

Parameters: template (str) – Path to the Jinja template for sphinx config file – see ${docConfigTemplate}

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