cvc5.git - CVC4 is an efficient open-source automatic theorem prover for satisfiability modulo theories (SMT) problems.

Age	Commit message (Collapse)	Author
2021-06-01	docs: Restructure index page, fix style issue. (#6657)	Aina Niemetz

2021-05-26	Reduce size of sphinx-gh output (#6601)	Gereon Kremer
	This PR reduces the disk size of the docs generated by make sphinx-gh. Apart from reformatting the cmake source, we now not only remove the _sources folder, but also .doctrees (essentially the sphinx cache) and _static/fonts/ (the fonts that are actually used live in _static/css/fonts). In combination, this now reduces the disk size from about 20MB (sphinx) to less than 6MB (sphinx-gh). Furthermore this PR only uploads the generated documentation if it differs from whatever we currently have for master. This is relevant to make the docs-ci repository smaller (which already has more than 5GB...)
2021-05-19	Generate command line options for sphinx docs (#6555)	Gereon Kremer
	This PR adds documentation about the command line options to the sphinx documentation. It is mostly a reformatted version of what --help would print.
2021-05-04	Improve generation of python API documentation (#6482)	Gereon Kremer
	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-04-27	Use std::hash for API types (#6432)	Gereon Kremer
	This PR replaces all api::*HashFunction objects by specializations of std::hash. std::hash is meant to be extended in this way, and it allows for a much cleaner usage of std::unordered_set and std::unordered_map with these types.
2021-04-26	Generate docs conf.py by cmake (#6441)	Gereon Kremer
	This PR makes cmake generate the sphinx configuration file. This will simplify dynamically modifying this file in the future, for example to add custom paths within the build directory (for the python API).
2021-04-21	cmake: Add optional module name argument for check_python_module helper. (#6406)	Mathias Preiner
	Addtionally adds checks for required documentation modules.
2021-04-20	Split C++ API docs from general docs (#6365)	Gereon Kremer

2021-04-14	Improve documentation of API kinds (#6341)	Gereon Kremer
	This PR improves the documentation of the api::Kind enum. Note that the docs for many of the enum values should still be improved. This PR merely makes sure that everything that is already there is actually output (/* vs /**) and properly rendered (missing spacing between lists, some formulas, etc).
2021-04-13	API docs: Add custom target to build for GH pages. (#6335)	Aina Niemetz

2021-04-12	Refactor and update copyright headers. (#6316)	Aina Niemetz

2021-04-07	New C++ Api: Initial setup of Api documentation. (#6295)	Aina Niemetz
	This configures the initial setup for generating Api documentation with Sphinx via Breathe and Doxygen. All fixes in the documentation of the cvc5.h header are for the purpose of eliminating warnings. This PR does not check for completeness of the documentation, and does not yet tweak the documentation to be nice, beautiful and consistent, which is postponed to future PRs. Configure with `--docs`, and then make. This will generate a `docs` directory in the build directory. The Sphinx documentation can be found at `build/docs/sphinx/index.html`. Doxygen documentation is only generated as xml under `build/docs/doxygen`. This PR further proposes a new style for copyright headers. If this style is approved, I will submit a PR to update the update_copyright.pl script.