20 Commits

Author SHA1 Message Date
Alex Ozdemir
b2c7ea88a3 Write-up for Pythonic API quickstart (#8566) 2022-04-05 02:49:30 +00:00
Alex Ozdemir
1ae29f4353 Bump Pythonic (transcendentals) & exception example (#8553)
- Bump version of Pythonic API to include transcendentals.
- Document Pythonic API's transcendentals.
- Add exception Pythonic API example.
2022-04-04 20:11:30 +00:00
Gereon Kremer
f65550a404 Follow renaming within pythonic API (#8532)
We are renaming files in the pythonic API to make it look less like it is somehow part of z3 (but still acknowledge that we took code from z3Py properly). This PR follows the change in cvc5/cvc5_pythonic_api#80.
2022-04-02 18:31:32 +00:00
mudathirmahgoub
6c421a8221 Add examples/bags.cpp (#8463) 2022-03-31 15:17:22 +00:00
Abdalrhman Mohamed
f1ba9b8542 Show the code for utilities in the docs. (#8387)
This PR adds the code for printing synthesis solutions to the docs. Various other changes are made to increase the consistency between the different bindings.

Signed-off-by: Abdalrhman M Mohamed <abdalrhman-mohamed@uiowa.edu>
2022-03-30 02:11:08 +00:00
Gereon Kremer
3f4895d558 Some random documentation issues (#7921)
This PR fixes a few issues in the documentation, mostly about examples that were not included where they should be.
2022-01-18 20:32:17 +00:00
Alex Ozdemir
e8a14a4051 Add new idiomatic examples (#7912) 2022-01-11 00:49:02 +00:00
mudathirmahgoub
437c346559 Add relations.cpp, relations.py examples (#7801) 2021-12-17 19:23:16 +00:00
Gereon Kremer
881464ade1 Turn kinds in python API into a proper Enum (#7686)
This PR does multiple things:
- the kinds are changed from custom objects to a proper enum.Enum class
  (including according changes to the cython code and the kind generation scripts)
- all examples and tests are modified to account for the change how to use kinds
  (Kind instead of kinds)
- add docstrings to the kind enum values
- add a custom documenter that properly renders enums via autodoc
- extend doxygen setup so that we can write comments as rst (allowing us to copy
  the documentation for kinds from the cpp api to the other apis)
2021-12-08 04:16:03 +00:00
Gereon Kremer
8ce83ed350 Add the first example for z3pycompat (#7722)
This PR adds the first example for the z3py compat API.
2021-12-01 16:32:16 +00:00
Gereon Kremer
bcabf70ae1 Extend docs example extension (#7717)
This PR extends the custom sphinx extension for examples. It now allows for simple patterns in the file names and matches the file types using arbitrary regular expressions instead of just looking at the file extensions. This is necessary to integrate examples from the z3pycompat API: the examples live at a nontrivial place (in the build folder), which we inject via the file name patterns; we will have two separate examples which both end in .py but can be distinguished via the pattern used in the beginning.
2021-11-30 22:37:30 +00:00
Gereon Kremer
5cfbb67e22 Various minor docs improvements (#7626)
This PR does a number of minor improvements to the docs.
2021-11-12 02:27:53 +00:00
Gereon Kremer
ae7084ba7a Add sygus examples to documentation (#7303)
For some reason, we didn't have any SMT-LIB (or rather SyGuS) example files for the SyGuS examples yet.
This PR adds these missing examples.
2021-10-04 16:46:49 -07:00
mudathirmahgoub
98e884a740 Update java examples using the new Java API (#7225)
This PRs updates java examples using the new Java API, by converting C++ examples to Java.
Examples CVC4Streams.java and PipedInput.java are removed since they are not longer supported by the API.
All examples are not included in the build which would be added in a future PR.
2021-10-01 23:21:02 +00:00
Aina Niemetz
175fbd30ef quickstart: Add python example to docs. (#6949) 2021-07-29 17:45:25 +00:00
Haniel Barbosa
c05fe825c6 Porting C++ API examples to SMT-LIB examples (#6789)
SyGuS examples will come later.
2021-07-06 16:29:25 +00:00
Aina Niemetz
8f98fded91 docs: Fix config to produce unique Sphinx section labels. (#6767) 2021-06-19 04:16:29 +00:00
Aina Niemetz
226244a0bd docs: Migrate sets and relations theory reference. (#6698)
This migrates page https://cvc4.github.io/sets-and-relations.
It further adds the SMT2 version of examples/api/cpp/sets.cpp and adds
test/regress/regress0/rels/relations-ops.smt2 as smtlib example for
relations.
2021-06-09 20:44:13 +00:00
Gereon Kremer
7440f0568b Add more examples to the documentation (#6569)
This PR adds (most of) the existing examples to the documentation, and does some other minor updates on the documentation. Some details:
- for consistency, all cpp examples are moved from examples/api to examples/api/cpp
- add capabilities for SMT-LIB examples, and two simple smt2 examples
- more docs/examples/*.rst files
- two new documentation categories: installation (how to obtain, compile and install cvc5) and binary (about the cvc5 binary)
2021-05-26 06:30:45 +00:00
Gereon Kremer
54c3b8f716 Basic setup for examples in documentation (#6383) 2021-04-20 19:37:18 +00:00