1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-01 17:36:21 +03:00
occt/dox/build/build_documentation/building_documentation.md
dpasukhi 73ec4a59da Documentation - Move gendoc to adm directory #199
Update documentation paths and improve generation instructions
2024-12-16 16:17:31 +00:00

20 lines
664 B
Markdown

Build Documentation {#build_upgrade__building_documentation}
=================
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) located in `adm` directory 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 @ref occt_contribution__documentation for prerequisites and details on OCCT documentation system.