docs/api/python/base/python.rst

Base Python API
========================

.. only:: not bindings_python

    .. warning::

        This documentation was built while python bindings were disabled. This part of the documentation is likely either empty or outdated. Please enable :code:`BUILD_BINDINGS_PYTHON` in :code:`cmake` and build the documentation again.

This is the base Python API.
It is an almost exact copy of the :doc:`C++ API <../../cpp/cpp>`.

See the :doc:`pythonic API <../pythonic/pythonic>` for a higher-level programming experience.

.. toctree::
    :maxdepth: 2

    quickstart
    datatype
    datatypeconstructor
    datatypeconstructordecl
    datatypedecl
    datatypeselector
    grammar
    kind
    op
    result
    roundingmode
    solver
    sort
    statistics
    synthresult
    term
    unknownexplanation
Rename python APIs (#7950) Rename python APIs to "base" and "pythonic" 2022-01-14 13:45:19 -08:00			`Base Python API`
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 11:40:49 -08:00			`========================`

			`.. only:: not bindings_python`

			`.. warning::`

			This documentation was built while python bindings were disabled. This part of the documentation is likely either empty or outdated. Please enable :code:`BUILD_BINDINGS_PYTHON` in :code:`cmake` and build the documentation again.

Rename python APIs (#7950) Rename python APIs to "base" and "pythonic" 2022-01-14 13:45:19 -08:00			`This is the base Python API.`
			It is an almost exact copy of the :doc:`C++ API <../../cpp/cpp>`.

			See the :doc:`pythonic API <../pythonic/pythonic>` for a higher-level programming experience.

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 11:40:49 -08:00			`.. toctree::`
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-07 20:16:03 -08:00			`:maxdepth: 2`
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 11:40:49 -08:00
			`quickstart`
			`datatype`
			`datatypeconstructor`
			`datatypeconstructordecl`
			`datatypedecl`
			`datatypeselector`
			`grammar`
Add kinds to python docs (#7672) This PR adds the kinds to the documentation for the regular python docs. 2021-11-23 12:59:26 -08:00			`kind`
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 11:40:49 -08:00			`op`
			`result`
			`roundingmode`
			`solver`
			`sort`
Python api: Various fixes in docs. (#8480) 2022-03-31 22:45:33 -07:00			`statistics`
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 16:56:33 -05:00			`synthresult`
			`term`
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 11:40:49 -08:00			`unknownexplanation`