docs/api/python/python.rst

.. _python-api:

Python API Documentation
========================

.. 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.

.. toctree::
    :maxdepth: 1

    quickstart
    datatype
    datatypeconstructor
    datatypeconstructordecl
    datatypedecl
    datatypeselector
Add more examples to the documentation (#6569) This PR adds (most of) the existing examples to the documentation, and does some other minor updates on the documentation. Some details: - for consistency, all cpp examples are moved from examples/api to examples/api/cpp - add capabilities for SMT-LIB examples, and two simple smt2 examples - more docs/examples/*.rst files - two new documentation categories: installation (how to obtain, compile and install cvc5) and binary (about the cvc5 binary) 2021-05-26 08:30:45 +02:00			`.. _python-api:`

Initial setup for docs of python API (#6445) This PR adds the basic setup for including the python API in our sphinx documentation and shows how it works using the Datatype class as an example. In detail - it enables sphinx.ext.autodoc and makes sure the generated pycvc5 is in the search path - adds a index page for the python API - adds a page for the Datatype class - adds docstrings for the Datatype class - does some finetuning (remove source locations, but adds signature information) 2021-04-27 15:29:19 +02:00			`Python API Documentation`
			`========================`

Improve generation of python API documentation (#6482) This PR makes generating the python part of our API documentation more reliable. If python bindings are enabled, it makes the docs target depend on pycvc5 and renders a warning into the documentation if python bindings are disabled. To make the dependency on pycvc5 work properly, it changes the python bindings build so that the library is directly put in the right place and avoid the manual rename, so that the pycvc5 target actually points to the correct file. Unfortunately, this means we need to build libcvc5 when building docs with python bindings enabled. 2021-05-04 18:33:59 +02: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.

Initial setup for docs of python API (#6445) This PR adds the basic setup for including the python API in our sphinx documentation and shows how it works using the Datatype class as an example. In detail - it enables sphinx.ext.autodoc and makes sure the generated pycvc5 is in the search path - adds a index page for the python API - adds a page for the Datatype class - adds docstrings for the Datatype class - does some finetuning (remove source locations, but adds signature information) 2021-04-27 15:29:19 +02:00			`.. toctree::`
Add python quick start guide (#7024) 2021-08-20 02:32:57 +03:00			`:maxdepth: 1`
Initial setup for docs of python API (#6445) This PR adds the basic setup for including the python API in our sphinx documentation and shows how it works using the Datatype class as an example. In detail - it enables sphinx.ext.autodoc and makes sure the generated pycvc5 is in the search path - adds a index page for the python API - adds a page for the Datatype class - adds docstrings for the Datatype class - does some finetuning (remove source locations, but adds signature information) 2021-04-27 15:29:19 +02:00
Add python quick start guide (#7024) 2021-08-20 02:32:57 +03:00			`quickstart`
python docs for Datatype-related classes (#7058) 2021-08-30 22:32:24 +03:00			`datatype`
			`datatypeconstructor`
			`datatypeconstructordecl`
			`datatypedecl`
			`datatypeselector`