diff options
| author | Gereon Kremer <gkremer@stanford.edu> | 2021-05-04 18:33:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-04 18:33:59 +0200 |
| commit | f41ae5481e9eb68aeeb87d57fca89e63501c6213 (patch) | |
| tree | 5d012529e08b89f7a4ef4deb57c542ae111059e8 /docs/python/python.rst | |
| parent | 441c53b1a68cc16a345eb0dc8d9956c1301ed509 (diff) | |
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.
Diffstat (limited to 'docs/python/python.rst')
| -rw-r--r-- | docs/python/python.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/python/python.rst b/docs/python/python.rst index 6d094488f..50d9077df 100644 --- a/docs/python/python.rst +++ b/docs/python/python.rst @@ -1,6 +1,12 @@ 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: 2 |