To generate HTML documentation, run the generate_docs.py script from any sub-directory of the repository (most likely build). To display the proper version of UMF in the documentation title, set the UMF_VERSION variable before running the script.

cd build
$ UMF_VERSION=<your version, e.g. "0.12.1"> python ../docs/generate_docs.py

Documentation can also be built using the build target 'docs' (see details below).

This script will create ./docs_build sub-directory, where the intermediate and final files will be created. HTML docs will be in the ./docs_build/generated/html directory.

To run documentation generation via build target use CMake commands below. To enable this target, python executable (in required version) has to be found in the system.

cmake -B build
cmake --build build --target docs

Script to generate HTML docs requires:

• Doxygen at least v1.9.1
• Python at least v3.8
• and python pip requirements, as defined in third_party/requirements.txt