diff options
| author | Gereon Kremer <nafur42@gmail.com> | 2021-10-04 13:59:28 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-04 20:59:28 +0000 |
| commit | 3630215cc02f7243fccba0a8078dd251a252abdc (patch) | |
| tree | 98950d44590fe6e983c9bb2934505b4224121b86 /src/api | |
| parent | 3279dca5b019f67cbb26be2fb146f2e82a674123 (diff) | |
Various improvements to documentation (#7283)
This PR adds a couple of improvements to our documentation setup
- add an explicit dependency on the extension so that sphinx rebuilds pages appropriately when an extension is modified
- sphinx now emits warnings for examples that are not implemented in all languages (smt2, cpp, java and python)
- add -v to make the sphinx output more log-file friendly
- avoid a warning when the java bindings (and thus java docs) are not build
- replace file(WRITE by configure_file to avoid rather common erroneous rebuilds of python docs
- fix a reference to a label in the python docs
- suppress timestamps in javadoc output to avoid docs-ci being triggered for every PR
- improve placeholder message when java bindings are disabled
Diffstat (limited to 'src/api')
| -rw-r--r-- | src/api/python/CMakeLists.txt | 6 | ||||
| -rw-r--r-- | src/api/python/__init__.py.in | 4 | ||||
| -rw-r--r-- | src/api/python/cvc5.pxi | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/src/api/python/CMakeLists.txt b/src/api/python/CMakeLists.txt index dce0208cb..74d1d84fc 100644 --- a/src/api/python/CMakeLists.txt +++ b/src/api/python/CMakeLists.txt @@ -111,11 +111,7 @@ python_extension_module(pycvc5) # Installation based on https://bloerg.net/2012/11/10/cmake-and-distutils.html # Create a wrapper python directory and generate a distutils setup.py file configure_file(setup.py.in setup.py) -file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/pycvc5/__init__.py -"import sys -from .pycvc5 import * -# fake a submodule for dotted imports, e.g. from pycvc5.kinds import * -sys.modules['%s.%s'%(__name__, kinds.__name__)] = kinds") +configure_file(__init__.py.in pycvc5/__init__.py) # figure out if we're in a virtualenv execute_process(OUTPUT_VARIABLE IN_VIRTUALENV diff --git a/src/api/python/__init__.py.in b/src/api/python/__init__.py.in new file mode 100644 index 000000000..9116976c3 --- /dev/null +++ b/src/api/python/__init__.py.in @@ -0,0 +1,4 @@ +import sys +from .pycvc5 import * +# fake a submodule for dotted imports, e.g. from pycvc5.kinds import * +sys.modules['%s.%s'%(__name__, kinds.__name__)] = kinds diff --git a/src/api/python/cvc5.pxi b/src/api/python/cvc5.pxi index 7659740de..0f6b54dc6 100644 --- a/src/api/python/cvc5.pxi +++ b/src/api/python/cvc5.pxi @@ -1867,7 +1867,7 @@ cdef class Solver: ( get-unsat-core ) - Requires to enable option :ref:`produce-unsat-cores <lbl-produce-unsat-cores>`. + Requires to enable option :ref:`produce-unsat-cores <lbl-option-produce-unsat-cores>`. :return: a set of terms representing the unsatisfiable core """ |