# 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](https://nmk-base.readthedocs.io/en/stable/extend.html#plugin-information).


## Venv

The **`nmk-doc`** plugin automatically requires the following python packages to be installed in the [project venv](https://nmk-base.readthedocs.io/en/stable/extend.html#python-modules-dependencies):
* [sphinx](https://pypi.org/project/sphinx/)
* [sphinx_rtd_theme](https://pypi.org/project/sphinx_rtd_theme/)
* [myst-parser](https://pypi.org/project/myst-parser/)

## Badges

A badge is declared (to be generated by [**`nmk-badges`**](https://nmk-badges.readthedocs.io/en/stable/extend.html#badges-definition) plugin in **README.md** file) to reference the project documentation build on [readthedocs](https://readthedocs.org) site.

This badge is enabled only if {ref}`${docInputs}<docinputs>` config item is not empty. \
This badge is enabled unless {ref}`${docRTDDisabled}<docRTDDisabled>` config item is true.

> **Note:** enabled only if [**`nmk-badges`** plugin](https://nmk-badges.readthedocs.io/) is used in the nmk project

## VSCode extensions

**`nmk-doc`** plugin [recommends](https://nmk-vscode.readthedocs.io/en/stable/extend.html#extensions) usage of the [Live Preview](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) 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](https://nmk-vscode.readthedocs.io/) is used in the nmk project