3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-09-08 02:31:24 +00:00
z3/doc
copilot-swe-agent[bot] 2e031bc7fc Add comprehensive documentation and examples for UserPropagator quantifier instantiation callbacks
Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>
2025-08-29 01:49:26 +00:00
..
CMakeLists.txt cmake: Use FindPython3. (#7019) 2023-11-27 11:20:21 +01:00
design_recfuns.md wip: add recursive functions 2017-12-25 22:51:39 +01:00
mk_api_doc.py Centralize and document TRACE tags using X-macros (#7657) 2025-05-28 14:31:25 +01:00
mk_params_doc.py Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612) 2023-02-28 11:46:10 -08:00
mk_tactic_doc.py Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612) 2023-02-28 11:46:10 -08:00
quantifier_instantiation_callback.md Add comprehensive documentation and examples for UserPropagator quantifier instantiation callbacks 2025-08-29 01:49:26 +00:00
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in Fix warning about \ref when building website.dox 2022-08-01 18:51:20 +03:00
z3api.cfg.in Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00
z3code.dox Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00

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'