forked from openvinotoolkit/openvino
-
Notifications
You must be signed in to change notification settings - Fork 0
BuildingDocumentation
Pavel Esir edited this page May 12, 2021
·
4 revisions
The procedure is validated on Windows and Ubuntu operation systems.
- Installing dependencies
- Building documentation
In addition to usual build dependencies doxygen
and latex
must be installed:
- 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
You should run cmake
with -DENABLE_DOCS=ON
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" \
-DENABLE_DOCS=ON \
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
© Copyright 2018-2022, OpenVINO team
- Home
- General resources
- How to build
-
Developer documentation
- Inference Engine architecture
- OpenVINO Python API
- CPU plugin
- GPU plugin
- HETERO plugin architecture
- Snippets
- Sample for IE C++/C/Python API
- Proxy plugin (Concept)
- Tests