Commit Graph

40 Commits

Author SHA1 Message Date
yoni206
b314d8d5c5 Add dependencies information for python bindings installation on M1/M2 (#9289) 2023-03-07 18:14:28 -08:00
yoni206
b383a0c995 Docs for installing python API in M1 (#9176)
Adds documentation instructions for the python API on M1 MacOS.
2022-10-13 15:32:49 +00:00
Aina Niemetz
9c176f263b docs: Do not use explicit line numbers in literalinclude. (#8690) 2022-05-02 20:13:00 +00:00
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
Mathias Preiner
e434fdd15b docs: Add Python installation instructions for pip. (#8538) 2022-04-02 02:26:33 +00:00
Andrew Reynolds
904f7c5524 Add a few miscellaneous pieces of documentation (#8533) 2022-04-02 01:02:47 +00:00
Gereon Kremer
3c18371323 Document special member functions in python API (#8513)
This PR documents relevant special member functions __getitem__ and __iter__ for some classes in the base python API.
2022-04-01 13:12:10 -07:00
Aina Niemetz
506a7b8c4a Python API: Do not rename enumerators. (#8507)
Co-authored-by: Mathias Preiner <mathias.preiner@gmail.com>
Co-authored-by: mudathirmahgoub <mudathirmahgoub@gmail.com>
Co-authored-by: Gereon Kremer <gkremer@stanford.edu>
2022-04-01 19:45:36 +00:00
Aina Niemetz
8ef22792d2 Python api: Various fixes in docs. (#8480) 2022-04-01 05:45:33 +00:00
Mathias Preiner
f66e2adea0 docs: Remove api namespace. (#8455) 2022-03-31 02:30:21 +00:00
Andrew Reynolds
ba24986fe2 Add SynthResult to the API (#8370)
Does not modify the code to return a SynthResult yet, just adds the class.

Co-authored-by: Aina Niemetz <aina.niemetz@gmail.com>
2022-03-23 21:56:33 +00:00
Gereon Kremer
ea5e75d04a Integrate pythonic api (#8131)
We decided we want to ship the pythonic API together with our base python API.
This PR adds a new target cvc5_python_api that first builds the base python API and then copies the pythonic API over. Furthermore we now use the cvc5.pythonic module to generate the corresponding documentation.
2022-03-03 02:16:09 +00:00
Gereon Kremer
8002adccc9 Use Add instead of Plus (#8043)
This fixes the current documentation builds for the pythonic API
2022-02-04 01:19:08 +00:00
Alex Ozdemir
6388657820 Change name of Python API's package from pycvc5 to cvc5. (#7953)
In the process, I changed a CMake target name from pycvc5 to
cvc5_base_py_api. I could not change the target to cvc5, because that
name is taken.
2022-02-02 23:45:42 +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
082ffeaffc Rename python APIs (#7950)
Rename python APIs to "base" and "pythonic"
2022-01-14 21:45:19 +00:00
Alex Ozdemir
e8a14a4051 Add new idiomatic examples (#7912) 2022-01-11 00:49:02 +00:00
Alex Ozdemir
5a3a6090c6 Python Idomatic API: Document solver, results, utilities, and fns (#7882)
I put fns into "Core & Booleans".
2022-01-07 20:42:28 +00:00
Alex Ozdemir
a2f099d72f Document quantifiers in idiomatic python API (#7880) 2022-01-07 04:37:08 +00:00
Alex Ozdemir
e1c81278ec Py idiomatic API: Doc sets, datatypes, FP (#7877) 2022-01-05 20:47:09 +00:00
Alex Ozdemir
48e880074f More documentation for idiomatic python API (#7798)
Arithmetic, bit-vectors, arrays.
2021-12-17 18:42:48 +00:00
Aina Niemetz
eb3b04319a api: Fix smt-lib code blocks and math in C++ docs. (#7795) 2021-12-15 15:09:51 -08: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