Commit Graph

4 Commits

Author SHA1 Message Date
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
38e4cf3fe6 Add kinds to python docs (#7672)
This PR adds the kinds to the documentation for the regular python docs.
2021-11-23 20:59:26 +00:00
yoni206
feae0b3040 Python API documentation: terms (#7659)
This PR adds documentation for the Terms class in the python API.
Co-authored-by: Gereon Kremer gereon.kremer@cs.rwth-aachen.de
2021-11-23 17:34:14 +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