mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-27 10:55:50 +00:00
Code Activity
7672 commits 24 branches 48 tags 158 MiB
Commit graph

50 commits

Author SHA1 Message Date
Dan Liew
1a0bff7480 [CMake] When invoking mk_api_doc.py pass the build directory. 
This change was requested by @wintersteiger as an alternative way
to unbreak the TravisCI builds.
 2017-11-13 22:31:05 +00:00
Christoph M. Wintersteiger
d44d918414 API doc build fix. Related to #1350. 2017-11-11 14:19:38 +00:00
Christoph M. Wintersteiger
a173b0faf7 Fixed API doc build 2017-11-09 13:34:32 +00:00
Max ulidtko
ce6e26043a fix Python API doxygen (make api_docs) 2017-09-27 14:07:18 +03:00
Max ulidtko
f07b89df86 fix pydoc part of make api_docs 2017-09-27 14:07:02 +03:00
Nikolaj Bjorner
2b0106c199 doc fixes 
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
 2017-07-09 11:26:27 +02:00
Dan Liew
4b517b96df [CMake] Move CMake files into their intended location so the 
`contrib/cmake/bootstrap.py` script no longer needs to be executed.

The previous location of the CMake files was a compromise proposed
by @agurfinkel in #461. While this has served us well (allowing progress
to be made) over time limitations of this approach have appeared.

The main problem is that doing many git operations (e.g. pull, rebase)
means the CMake files don't get updated unless the user remembers to
run the script. This can lead to broken and confusing build system
behaviour.

This commit only does the file moving and necessary changes to
`.gitignore`. Other changes will be done in subsequent commits.
 2017-06-12 11:59:00 +01:00
Dan Liew
903709b9c1 [Doxygen] Fix bug where some header files were not being scanned. 2017-06-07 17:09:01 +01:00
Dan Liew
6261a5c27b Fix bug in mk_api_doc.py where the Z3 python package path would be 
checked when building the Z3 python package documentation was disabled.
 2017-05-04 15:28:20 +01:00
Dan Liew
a6a6a9c29f [Doxygen] Fix link to ".NET" documentation it should point to the 
"Microsoft.Z3" namespace, not the "Microsoft.Z3.Context" class.

This mirrors the link provided for the Java API.
 2017-04-26 11:02:36 +01:00
Dan Liew
121fd06cc2 [Doxygen] Fix mk_api_doc.py so it is not required that the current 
working directory be the `doc` directory in the source tree.
 2017-04-26 10:44:01 +01:00
Dan Liew
e4bec1572a [Doxygen] Teach mk_api_doc.py to allow multiple search paths 
for the ".NET" and "Java" bindings. The CMake build system needs
this because the generated files exist in a different directory
to the source files.

Multiple paths can be specified using the `--dot-search-paths` and
`--java-search-paths` options.
 2017-04-26 10:42:57 +01:00
Dan Liew
09d7ebf1ad [Doxygen] Fix bug where temporary directory and output directory 
paths were not handled properly if paths contained spaces.
 2017-04-26 10:42:57 +01:00
Dan Liew
fa8f6f20a5 [Doxygen] Teach mk_api_doc.py to prevent ".NET", "Z3py" and "Java" 
bindings from appearing in the generated documentation. This can
be enabled with `--no-dotnet`, `--no-z3py`, and `--no-java`
respectively.

This fine-grained control is being added for the CMake build system
which will need this control.
 2017-04-26 10:42:57 +01:00
Dan Liew
cb6baa8bcb [Doxygen] Put the path to the directory containing the Z3py package 
at the beginning of the search path so it is picked up first. This
is to try to avoid picking an installed copy of Z3py.
 2017-04-26 10:42:57 +01:00
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
Dan Liew
33af478ce2 [Doxygen] Fix some indentation in doxygen configuration file template. 2017-04-26 10:42:57 +01:00
Dan Liew
c78bf66df3 [Doxygen] Fix bug in mk_api_doc.py where the generated 
doxygen configuration would not point at the correct path to
the temporary directory.
 2017-04-26 10:42:57 +01:00
Dan Liew
5a66f05384 [Doxygen] Teach mk_api_doc.py to use @ style substitutions 
to control whether OCaml documentation link is emitted.
 2017-04-26 10:42:57 +01:00
Dan Liew
b4f8b001ce [Doxygen] Teach mk_api_doc.py a new command line option 
(`--output-dir`) to control where output files are emitted.

This is implemented by making `z3api.dox` a template file
(renamed `z3api.cfg.in`) and populating the template at build
time with the required settings.
 2017-04-26 10:42:57 +01:00
Dan Liew
5f7ae920c6 [Doxygen] Teach mk_api_doc.py a new command line option (--temp-dir) 
which allows the location of the temporary directory to be controlled.

While I'm here also write `website.dox` into the temporary directory
where it belongs instead of in the source tree and simplify the logic
that deletes the temporary directory and its contents.
 2017-04-26 10:42:48 +01:00
Dan Liew
8a1df3df62 [Doxygen] Add --doxygen-executable command line option to 
`mk_api_doc.py`. This allows a custom path to Doxygen to be specified.
 2017-04-24 21:52:59 +01:00
Dan Liew
2cdb45605d [Doxygen] Switch to using argparse to parse command line arguments 
in `mk_api_doc.py`. Given that we need to add a bunch of new command
line options it makes sense to use a less clumsy and concise API.
 2017-04-24 21:48:34 +01:00
Dan Liew
ca678c3675 [Doxygen] Fix bug where def_Type directives in z3.h would appear 
in generated doxygen documentation.
 2017-04-24 15:45:57 +01:00
Dan Liew
81ba729aab [Doxygen] Fix script --help functionality. 2017-04-24 15:25:45 +01:00
Michael Lowell Roberts
3415672f31 fixed bug where mk_make.py --build=... would fail to handle absolute paths correctly. 2017-02-28 08:24:35 -08:00
Christoph M. Wintersteiger
aaf449ae27 Fix for the documentation scripts. Fixes #799. 2016-11-21 14:49:32 +00:00
Bohao Zhang
749e1a1fb1 Clean up README 
mentioning C++ and Java.
 2016-03-23 16:14:38 +01:00
Christoph M. Wintersteiger
00271e5531 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
Christoph M. Wintersteiger
2c6645ef2d Python 3.x issues 2015-12-03 13:57:29 +00:00
Nikolaj Bjorner
e0068e4065 C/right on python scripts 
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
 2015-06-10 12:01:47 -07:00
Christoph M. Wintersteiger
a5036769b3 ML API doc fix 2015-04-13 17:46:18 +01:00
Christoph M. Wintersteiger
bf00723d37 Updated links in the documentation 2015-04-13 17:37:58 +01:00
Christoph M. Wintersteiger
f993d3df15 Documentation generator bugfixes and updates. 2015-04-13 17:33:26 +01:00
Christoph M. Wintersteiger
2cb84280d8 Final adjustments for the FP integration 
Signed-off-by: Christoph M. Wintersteiger <cwinter@microsoft.com>
 2015-01-21 17:58:31 +00:00
Christoph M. Wintersteiger
0713535fa6 Documentation website fixes. 
Signed-off-by: Christoph M. Wintersteiger <cwinter@microsoft.com>
 2014-10-24 21:00:23 +01:00
Christoph M. Wintersteiger
ddebb4a69d Documentation fixes 
Signed-off-by: Christoph M. Wintersteiger <cwinter@microsoft.com>
 2014-10-24 19:45:21 +01:00
Leonardo de Moura
99d0449272 added Java docs 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-12-10 07:51:45 -08:00
Leonardo de Moura
4b27eae47f using doxygen to document z3py API 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 18:41:43 -08:00
Leonardo de Moura
b855313141 updated API doc generation 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 18:16:58 -08:00
Leonardo de Moura
a9a673bb8a New API website 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 17:53:43 -08:00
Leonardo de Moura
8ea61dacda Merge branch 'unstable' of https://git01.codeplex.com/z3 into unstable 2012-11-22 17:09:36 -08:00
Leonardo de Moura
85b9d8c37a improved Z3 documentation 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 17:09:30 -08:00
Leonardo de Moura
0111918aff mk_doc.py --> mk_api_doc.py 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 10:21:49 -08:00
Leonardo de Moura
5e7436cb50 Removed (some) dead parameters. Added doxygen documentation for the whole code base. 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-22 10:06:24 -08:00
Leonardo de Moura
f9c9d5e342 updated website 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-20 09:38:28 -08:00
Leonardo de Moura
b3b13541fb improved doc/README 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-20 00:31:55 -08:00
Leonardo de Moura
14944356f8 improving script 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-20 00:27:20 -08:00
Leonardo de Moura
d226d2f381 renamed script 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-20 00:19:44 -08:00
Leonardo de Moura
e0f5c0bd8e Added script for generating documentation for the C, .NET and Python APIs 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
 2012-11-20 00:18:43 -08:00