Generates the NAP Framework system documentation, available at docs.nap-framework.tech. Documentation includes the user manual and info on all available system resources. The user manual is generated from the .md files located in the app/manual directory. Framework documentation is extracted from NAP source code. Documentation is guaranteed to be in sync with the main branch.

docs.nap-framework.tech

Dependencies

• Python (3.8+)
  • pip
• doxygen
• graphviz
• git

Installation

Create a virtual python environment for the project and install all required python dependencies:

$ pip install --user pipenv
$ cd nap-docs
$ pipenv install

Build

Run the build.py script inside the app directory to auto-generate system documentation using doxygen. The script clones and pulls the NAP repo if required. The result will be copied into the docs directory.

$ pipenv shell
$ cd app
$ python build.py
$ exit