building_documentation

Build Documentation

DEPRECATION NOTICE: This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml).

To generate HTML documentation from sources contained in dox subdirectory, you need to have Tcl and Doxygen 1.8.5 (or above) installed on your system.

Use script gendoc (batch file on Windows, shell script on Linux / Mac OSX) to generate documentation.

To generate Overview documentation:

cmd> gendoc -overview

To generate Reference manual:

cmd> gendoc -refman

Run this command without arguments to get help on supported options.

See Link for prerequisites and details on OCCT documentation system.