11 Commits

Author SHA1 Message Date
Mathias Preiner
e434fdd15b docs: Add Python installation instructions for pip. (#8538) 2022-04-02 02:26:33 +00:00
Alex Ozdemir
082ffeaffc Rename python APIs (#7950)
Rename python APIs to "base" and "pythonic"
2022-01-14 21:45:19 +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
21b15a0464 Add documentation for z3py compatibility API (#7652)
This PR includes documentation for the z3py compatibility API into our general API.
It does so by adding the z3py compatibility API as an external project to download it and then have sphinx document it via the autodoc extension that we already use for our regular python API.
Right now we simply show everything on one page, which should be refactored in the future.
2021-11-17 19:40:49 +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
yoni206
cd5fb80d86 Python api documentation for sorts (#7440)
This PR adds documentation for the Sort python API.
2021-10-27 17:41:24 +00:00
yoni206
538eea94a5 Python api documentation: Op, Grammar, Result, Enums (#7095)
This PR adds documentation to the python class Op, Grammar, Result, and for API enums.
Additionally, documentation for isNull functions in the datatype classes is added for the python API, and a small change in the cpp API documentation is introduced.
2021-10-15 23:09:02 +00:00
Alex Ozdemir
41b0ff8aa9 Start python API Solver documentation (#7064) 2021-09-20 22:12:17 +00:00
yoni206
be403c18c6 python docs for Datatype-related classes (#7058) 2021-08-30 12:32:24 -07:00
yoni206
63ad6f0ce1 Add python quick start guide (#7024) 2021-08-19 23:32:57 +00:00
Aina Niemetz
cc666c9a93 docs: Restructure index page, fix style issue. (#6657) 2021-06-01 17:05:52 -07:00