nmk_doc.builders

Python module for nmk-doc plugin builders.

Classes

NmkDocSphinxBuilder	Builder used to trigger sphinx documentation build
PlantUmlBuilder	Builder used to trigger plantuml diagram generation
SnippetsBuilder	Builder used to generate documentation snippets

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, version: str = '')

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

Parameters:

• source_folder – doc source folder

• output_folder – doc output folder

• version – project version

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

Bases: nmk.model.builder.NmkTaskBuilder

Builder used to trigger plantuml diagram generation

build(jar: str, java_runtime: str, input_folder: str, output_folder: str, formats: list[str], extra_options: str)

Called by the puml.generate task, to generate diagrams

Parameters:

• jar – path to the PlantUML JAR file

• java_runtime – path to the Java runtime

• input_folder – input folder containing the diagram source files

• output_folder – output folder for the generated diagrams

• formats – list of output formats

• extra_options – extra options for the PlantUML command

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

Bases: nmk.model.builder.NmkTaskBuilder

Builder used to generate documentation snippets

build(snippets: dict[str, str], output_folder: str)

Called by the doc.snippets task, to generate documentation snippets

Parameters:

• snippets – dict of snippet name to command to execute

• output_folder – output folder for the generated snippets