mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-04 13:13:25 +03:00
0027191: Documentation - redesign of information architecture -- revision (build)
Revised documentation of building OCCT and third-parties; some related tags updated
This commit is contained in:
19
dox/build/build_documentation/building_documentation.md
Normal file
19
dox/build/build_documentation/building_documentation.md
Normal file
@@ -0,0 +1,19 @@
|
||||
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) 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.
|
Reference in New Issue
Block a user