mirror of
https://github.com/Z3Prover/z3
synced 2025-04-08 18:31:49 +00:00
`mk_api_doc.py` so that the location of the z3py package can be specified. This is needed by the CMake build system because the complete Z3py package is not emitted in the source tree. Also fix a bug in the path added to the module/package search path. The directory containing the `z3` package needs to be added not the `z3` package directory itself. |
||
---|---|---|
.. | ||
mk_api_doc.py | ||
README | ||
update_api_website.cmd | ||
update_code_website.cmd | ||
website.dox.in | ||
z3api.cfg.in | ||
z3code.dox |
API documentation ----------------- To generate the API documentation for the C, C++, .NET, Java and Python APIs, we must execute python mk_api_doc.py We must have doxygen installed in our system. The documentation will be stored in the subdirectory './api/html'. The main file is './api/html/index.html' Code documentation ------------------ To generate documentation for the Z3 code, we must execute doxygen z3code.dox We must also have dot installed in our system. The documentation will be store in the subdirectory './code/html'. The main file is './code/html/index.html'