Tasks

The nmk-doc plugin defines the tasks described below.

Setup tasks

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

doc.config – doc configuration file generation

This tasks generates the sphinx configuration file.

Property	Value/description
builder	nmk_doc.builders.NmkDocConfigBuilder
input	${gitVersion} value (current git version)
output	${docConfig} file
if	enabled only if ${docInputs} config item is not empty

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_doc.builders.NmkDocConfigBuilder
input	${docConfig} doc config file
output	${docRTDConfig} file
if	enabled only if ${docInputs} config item is not empty

Build tasks

All tasks in this chapter are dependencies of the 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 ${docInputs} config item is not empty