BuildingDocumentation

How to build documentation

The procedure is validated on Windows and Ubuntu operation systems.

Table of content:

• Installing dependencies
• Building documentation

Installing dependencies

In addition to usual build dependencies doxygen and latex must be installed:

Windows

• miktex
• doxygen (version >= 1.8.20)
• Graphviz

Ubuntu systems

• Latex and graphviz:

apt-get install texlive-full graphviz

• goxygen version >= 1.8.20:

$ git clone https://github.com/doxygen/doxygen.git
$ cd doxygen
$ git checkout Release_1_8_20
$ mkdir build
$ cd build
$ cmake ..
$ cmake --build . -j8
$ sudo make install

Building documentation

You should run cmake as usual and it will find all dependencies automatically on Ubuntu systems, while on Windows we still need to specify paths to the installed dependencies:

cmake -DLATEX_COMPILER="C:/Program Files/MiKTeX/miktex/bin/x64/latex.exe" \
      -DDOXYGEN_DOT_EXECUTABLE="C:/Program Files (x86)/Graphviz2.38/bin/dot.exe" \
      -DDOXYGEN_EXECUTABLE="C:/Program Files/doxygen/bin/doxygen.exe" \

Once the dependencies are found, the project must generated using CMake. The target openvino_docs must be built to generate doxygen documentation, the generated files can be found at <binary dir>/docs/html/index.html