summaryrefslogtreecommitdiff
path: root/docs/index.rst
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-06-04docs: Migrate datatypes theory reference. (#6662)Aina Niemetz
This migrates https://cvc4.github.io/datatypes.
2021-06-01docs: Migrate input languages page. (#6659)Aina Niemetz
This migrates page https://cvc4.github.io/input-languages.
2021-06-01docs: Restructure index page, fix style issue. (#6657)Aina Niemetz
2021-05-26Add more examples to the documentation (#6569)Gereon Kremer
This PR adds (most of) the existing examples to the documentation, and does some other minor updates on the documentation. Some details: - for consistency, all cpp examples are moved from examples/api to examples/api/cpp - add capabilities for SMT-LIB examples, and two simple smt2 examples - more docs/examples/*.rst files - two new documentation categories: installation (how to obtain, compile and install cvc5) and binary (about the cvc5 binary)
2021-05-19Generate 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-04-27Initial setup for docs of python API (#6445)Gereon Kremer
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)
2021-04-20Split C++ API docs from general docs (#6365)Gereon Kremer
2021-04-20Basic setup for examples in documentation (#6383)Gereon Kremer
2021-04-14Improve documentation for FP rounding mode, add bibliography (#6343)Gereon Kremer
Co-authored-by: Aina Niemetz <aina.niemetz@gmail.com>
2021-04-09New C++ Api: Initial layout of Api documentation. (#6325)Aina Niemetz
2021-04-07New 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.
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback