mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-05-06 02:15:16 +00:00
Code Activity
z3/doc
History
Kevin Phoenix 1a9990a92f
Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612)
2023-02-28 11:46:10 -08:00
..
CMakeLists.txt
design_recfuns.md
mk_api_doc.py
mk_params_doc.py
mk_tactic_doc.py
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in
z3api.cfg.in
z3code.dox Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00

README 

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'