3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-07-15 03:25:43 +00:00
z3/doc
Margus Veanes bd3cf8514c Add range-set integration handoff plan
Seed the range-set-integration branch with a handoff plan summarizing the
current range_predicate / seq_range_collapse infrastructure in master, the
two candidate integration approaches (first-class re.ranges AST node vs.
deeper internal-only use of range-sets), and a concrete evaluation plan
against master on the regex-equivalence and QF_S benchmarks.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-26 20:26:37 +03:00
..
test_go_doc git bindings v1.0 2026-02-15 21:24:40 -08:00
CMakeLists.txt git bindings v1.0 2026-02-15 21:24:40 -08:00
design_recfuns.md wip: add recursive functions 2017-12-25 22:51:39 +01:00
JAVA_IDE_SETUP.md Add comprehensive Java IDE setup documentation for ClassNotFoundException (#8260) 2026-01-19 22:24:22 -08:00
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 git bindings v1.0 2026-02-15 21:24:40 -08:00
mk_params_doc.py na 2025-12-19 14:13:14 -08:00
mk_tactic_doc.py Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612) 2023-02-28 11:46:10 -08:00
range_set_integration_plan.md Add range-set integration handoff plan 2026-06-26 20:26:37 +03:00
README git bindings v1.0 2026-02-15 21:24:40 -08:00
website.dox.in git bindings v1.0 2026-02-15 21:24:40 -08:00
z3api.cfg.in git bindings v1.0 2026-02-15 21:24:40 -08: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, 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'