23 Commits

Author SHA1 Message Date
Daniel Larraz
2d240c467a Fix duplicate C++ declarations in Sphinx documentation (#12069) 2025-09-08 15:08:58 +00:00
José Neto
867cdf6271 Category option info for Python and Java APIs (#12100) 2025-09-08 13:47:59 +00:00
Daniel Larraz
ec9cbcb6ce doc: Fix toctree consistency issues (#12090)
This PR addresses two issues reported by Sphinx. First, the
`docs/api/python/base/modes.rst` document was not included in any
toctree. Second, the `proofrule.rst` and `cvc5proofrule.rst` documents
were included in multiple toctrees. The latter is resolved by including
each document in only one toctree and referencing it elsewhere in the
documentation using cross-references.
2025-08-23 22:10:09 +00:00
Daniel Larraz
5b85cad4ee doc: Add missing references to c examples (#12089)
This PR also adds a `:skip:` directive to suppress missing-example
warnings for languages without an equivalent version.
2025-08-23 22:09:10 +00:00
Aina Niemetz
91201c459e Fix docs in preparation for upcoming release. (#11983) 2025-06-17 13:22:02 +00:00
Aina Niemetz
930012648d docs: python base: Add missing docs pages. (#11058) 2024-08-05 18:49:50 +00:00
Aina Niemetz
dab8236589 docs: python: Add missing docs text for pages. (#11057) 2024-08-05 18:47:34 +00:00
Aina Niemetz
1b9eab5c0e docs: Restructure and extend proofs docs. (#11045) 2024-07-16 23:07:30 +00:00
Aina Niemetz
cb103e26c3 docs: python base: Add docs for TermManager and SortKind. (#11056) 2024-07-16 22:39:37 +00:00
Aina Niemetz
441ef12d70 docs: Fixes in API documentation. (#11034) 2024-07-12 16:16:47 +00:00
Aina Niemetz
b9b4e1b9da c++ API: Refactor statistics handling. (#10530)
This moves term statistics collection from Solver to TermManager.
TermManager and Solver now both provide `getStatistics()`, the former
captures API level term statistics, the latter internal solver
statistics.

This also adds iterator capabilities to the Python Statistics class.
2024-04-01 21:12:16 +00:00
Aina Niemetz
1a3a935fb5 Python API: Refactor to expose TermManager. (#10488)
This refactors the base Python API to expose TermManager (related to
previous refactor of the C++ API to expose TermManager in #10426).
2024-03-14 14:34:58 -07:00
Hans-Jörg
0a35879fc1 Make Proof Rule enum a part of the API (#9925)
This pull requests makes the enum that lists all proof rules a part of the API.

It also renames the enum from PfRule to ProofRule. It also renames some unrelated types and function names that share the PfRule name (such as DslPfRule).
This rename unfortunately touches many files since PfRule is not an uncommon type. (second to last commit)
2023-09-27 00:58:03 +00:00
Aina Niemetz
9c176f263b docs: Do not use explicit line numbers in literalinclude. (#8690) 2022-05-02 20:13:00 +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
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
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