3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-04-12 07:20:34 +00:00
z3/doc
copilot-swe-agent[bot] 0ad40a3f54 Remove unnecessary blank lines in mk_genfile_common.py and mk_api_doc.py
Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>
2026-02-19 17:52:11 +00:00
..
test_go_doc
CMakeLists.txt
design_recfuns.md
JAVA_IDE_SETUP.md
mk_api_doc.py Remove unnecessary blank lines in mk_genfile_common.py and mk_api_doc.py 2026-02-19 17:52:11 +00:00
mk_go_doc.py
mk_params_doc.py
mk_tactic_doc.py
README
website.dox.in
z3api.cfg.in
z3code.dox

API documentation
-----------------

To generate the API documentation for the C, C++, .NET, Java, Python, and Go 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'

To include Go API documentation, use:

   python mk_api_doc.py --go

Note: Go documentation requires Go to be installed (for godoc support).

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'