Tasks

The nmk-doc plugin defines the tasks described below.

This diagram summarizes the available tasks, and how they are ordered in a given nmk project:

---

Setup tasks

All tasks in this chapter are dependencies of the base setup task.

---

📖.📝 doc.config – doc configuration file generation

This tasks generates the sphinx configuration file.

Property	Value/description
builder	nmk_base.common.TemplateBuilder
input	${docConfigTemplate} template file
output	${docConfig} file
if	enabled only if ${docIndex} config item is not empty Changed in version 1.1.0 – Previous enablement item was ${docInputs}

---

📖.📝 doc.rtd – Read The Docs build configuration file generation

This tasks generates the Read The Docs automated build configuration file.

Property	Value/description
builder	nmk_base.common.TemplateBuilder
inputs	${docConfig} doc config file ${docRTDConfigTemplate} template file
output	${docRTDConfig} file
if	enabled only if ${docIndex} config item is not empty Changed in version 1.1.0 – Previous enablement item was ${docInputs}

---

🏭.📥 puml.download – Download the PlantUML runtime

This tasks downloads the PlantUML runtime, needed to generate image files from input diagram files.

Property	Value/description
builder	nmk_base.common.DownloadBuilder
inputs	${PROJECTFILES}
output	${plantUmlLocalPath} file
if	${plantUmlReady}

Builder is called with the following parameters:

Parameter name	Value
url	${plantUmlDownloadUrl}
request_function	${requestFunction}

Added in version 1.1.0

---

Build tasks

All tasks in this chapter are dependencies of the base build.doc task.

Changed in version 1.2.0 – previous dependency was on main build task.

---

📖.🔨 doc.build – documentation build

This tasks builds the documentation by calling the sphinx tool.

Property	Value/description
builder	nmk_doc.builders.NmkDocSphinxBuilder
input	${docInputs} files
output	${docOutput} folder
if	enabled only if ${docIndex} config item is not empty Changed in version 1.1.0 – Previous enablement item was ${docInputs}

Builder is called with the following parameters:

Parameter name	Value
source_folder	${docPath}
output_folder	${docOutput}
version	${docVersion} Added in version 1.1.0

---

🏭.🔨 puml.generate – Generate the PlantUML diagram images

This tasks calls the PlantUML runtime to generate image files from input diagram files.

Property	Value/description
builder	nmk_doc.builders.PlantUmlBuilder
inputs	${plantUmlDiagrams} files
output	${plantUmlOutputFiles} files
if	${plantUmlReady}

Builder is called with the following parameters:

Parameter name	Value
jar	${plantUmlLocalPath}
java_runtime	${javaRuntime}
input_folder	${plantUmlDiagramsFolder}
output_folder	${plantUmlOutputFolder}
formats	${plantUmlOutputFormats}
extra_options	${plantUmlExtraOptions}

Added in version 1.1.0

---

📖.🧩 doc.snippets – Generate documentation snippets

This tasks generates documentation snippets as defined in the ${docSnippets} config item.

Property	Value/description
builder	nmk_doc.builders.SnippetsBuilder
inputs	${docSnippetsInputs} files
output	${docSnippetsOutputFiles} files
if	${docSnippets}

Builder is called with the following parameters:

Parameter name	Value
snippets	${docSnippets}
output_folder	${docSnippetsOutputFolder}

Added in version 1.2.0