3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-08 18:31:49 +00:00
z3/doc
Dan Liew e309174ec9 [Doxygen] Add --z3py-package-path command line option to
`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.
2017-04-26 10:42:57 +01:00
..
mk_api_doc.py [Doxygen] Add --z3py-package-path command line option to 2017-04-26 10:42:57 +01:00
README Clean up README 2016-03-23 16:14:38 +01:00
update_api_website.cmd improved Z3 documentation 2012-11-22 17:09:30 -08:00
update_code_website.cmd updated API doc generation 2012-11-22 18:16:58 -08:00
website.dox.in [Doxygen] Teach mk_api_doc.py to use @ style substitutions 2017-04-26 10:42:57 +01:00
z3api.cfg.in [Doxygen] Fix some indentation in doxygen configuration file template. 2017-04-26 10:42:57 +01:00
z3code.dox C API cleanup. Mainly removal of ML-specific macros that are not used anymore and inline documentation fixes. 2015-12-03 17:33:25 +00: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'