summaryrefslogtreecommitdiff
path: root/docs/api
AgeCommit message (Collapse)Author
2021-11-12Various minor docs improvements (#7626)Gereon Kremer
This PR does a number of minor improvements to the docs.
2021-11-10docs: Also create javadoc for generated Kind.java (#7624)Mathias Preiner
2021-11-10java: Fix building cvc5.jar for cmake 3.16. (#7623)Mathias Preiner
Fixes #7579.
2021-10-28Remove separate cpp docs for UnknownExplanation (#7516)Gereon Kremer
This removes the separate documentation for the `UnknownExplanation` enum, as it is already included in the documentation of the `Result` class.
2021-10-27Python api documentation for sorts (#7440)yoni206
This PR adds documentation for the Sort python API.
2021-10-22Refactor java package name from cvc5 to io.github.cvc5.api (#7340)mudathirmahgoub
This PR refactors java package name from cvc5 to io.github.cvc5.api. It also refactor the names of cpp and java files.
2021-10-15Python api documentation: Op, Grammar, Result, Enums (#7095)yoni206
This PR adds documentation to the python class Op, Grammar, Result, and for API enums. Additionally, documentation for isNull functions in the datatype classes is added for the python API, and a small change in the cpp API documentation is introduced.
2021-10-11Add CI workflow to test different cmake versions (#7254)Gereon Kremer
This refactors the CI setup by moving parts of the CI workflow into new composite actions. This allows to reuse this parts in a new workflow that tests against many different cmake versions. It is mostly useful after modifying our cmake setup to check compatibility with older cmake versions. The workflow is not triggered automatically, but can be started manually.
2021-10-07Add a binary / SMT-LIB quickstart (#7315)Gereon Kremer
This PR adds a binary/SMT-LIBv2 quickstart example, based on the cpp quickstart example.
2021-10-07Replace doubles by rationals in C++ quickstart (#7317)Gereon Kremer
This PR removes the conversion of rationals to double in favour of properly handling them as rationals (as pairs of integers) in the C++ quickstart example.
2021-10-06Remove timestamped javadoc comments (#7304)Gereon Kremer
This PR also removes the javadoc timestamps from index.html, which for some reason does not honor the -notimestamp option.
2021-10-04Various improvements to documentation (#7283)Gereon Kremer
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
2021-10-04No longer build docs by default. Use make docs. (#7296)Gereon Kremer
This PR changes our policy when to build the documentation. Beforehand, make docs was included in make and make all. Now, you need to run make docs explicitly.
2021-09-30Integrate javadoc documentation (#7278)Gereon Kremer
This PR adds the cmake setup to generate javadoc documentation for the java API and integrates it into the sphinx documentation. Right now, we simply link to the javadoc. This PR also modifies a bunch of javadoc comments to use proper javadoc syntax.
2021-09-20Start python API Solver documentation (#7064)Alex Ozdemir
2021-08-30Add API function to obtain information about a single option (#6980)Gereon Kremer
This PR adds api::Solver::getOptionInfo() that returns information about a single option, including its name, aliases, current and default value and its domain.
2021-08-30python docs for Datatype-related classes (#7058)yoni206
2021-08-19Add python quick start guide (#7024)yoni206
2021-07-29quickstart: Add python example to docs. (#6949)Aina Niemetz
2021-06-24api: getRealValue: Fix printing of integer values. (#6795)Aina Niemetz
2021-06-23docs: Add quickstart guide. (#6782)Aina Niemetz
2021-06-21docs: Split out and merge C++ class hierarchy. (#6781)Aina Niemetz
This restructures the entry page for the C++ API documentation in preparation for adding a quickstart and linking to examples and adding more content.
2021-06-09docs: Fix `Kind` description (#6712)Andres Noetzli
This commit changes the Kind description not to include C/C++ preprocessor statements and updates the kind of bit-vector addtion. It also marks some of the information as internal to exclude it from the public documentation.
2021-06-01docs: Restructure index page, fix style issue. (#6657)Aina Niemetz
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback