diff options
| author | Gereon Kremer <gkremer@stanford.edu> | 2021-04-27 15:29:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-27 15:29:19 +0200 |
| commit | 642c8b738e6681fe511dfb3610d896d3b67bbd7d (patch) | |
| tree | 26660ce4359f6104bd392cfac1ca46ae75d02ef9 /docs/conf.py.in | |
| parent | 20820daece2eaf340a944ff386ffbafed1b79b75 (diff) | |
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)
Diffstat (limited to 'docs/conf.py.in')
| -rw-r--r-- | docs/conf.py.in | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/conf.py.in b/docs/conf.py.in index 12bfa9ed0..28e8fa04c 100644 --- a/docs/conf.py.in +++ b/docs/conf.py.in @@ -15,6 +15,9 @@ import sys # add path to enable extensions sys.path.insert(0, '${CMAKE_CURRENT_SOURCE_DIR}/ext/') +# path to python api +sys.path.insert(0, '${CMAKE_BINARY_DIR}/src/api/python') + # -- Project information ----------------------------------------------------- @@ -30,6 +33,7 @@ author = 'The Authors of cvc5' # ones. extensions = [ 'breathe', + 'sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinxcontrib.bibtex', 'sphinx_tabs.tabs', |