Initial setup for docs of python API (#6445)
authorGereon Kremer <gkremer@stanford.edu>
Tue, 27 Apr 2021 13:29:19 +0000 (15:29 +0200)
committerGitHub <noreply@github.com>
Tue, 27 Apr 2021 13:29:19 +0000 (15:29 +0200)
commit642c8b738e6681fe511dfb3610d896d3b67bbd7d
tree26660ce4359f6104bd392cfac1ca46ae75d02ef9
parent20820daece2eaf340a944ff386ffbafed1b79b75
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)
cmake/UseCython.cmake
docs/conf.py.in
docs/index.rst
docs/python/datatype.rst [new file with mode: 0644]
docs/python/python.rst [new file with mode: 0644]
src/api/python/CMakeLists.txt
src/api/python/cvc5.pxi