Contributions

The nmk-doc plugin contributes to nmk features as described below.

Plugin information

As other plugins, nmk-doc registers its version and documentation link in plugin information config items.

Venv

The nmk-doc plugin automatically requires the following python packages to be installed in the project venv:

• sphinx

• sphinx_rtd_theme

• myst-parser

Badges

A badge is declared (to be generated by nmk-badges plugin in README.md file) to reference the project documentation build on readthedocs site.

This badge is enabled only if ${docInputs} config item is not empty.
This badge is enabled unless ${docRTDDisabled} config item is true.

Note: enabled only if nmk-badges plugin is used in the nmk project

VSCode extensions

nmk-doc plugin recommends usage of the Live Preview VSCode extension, in order to display generated documentation directly in the IDE (without needing an extra web browser).

Note: enabled only if nmk-vscode plugin is used in the nmk project