diff options
| author | Gereon Kremer <gereon.kremer@cs.rwth-aachen.de> | 2021-04-14 23:52:06 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-14 21:52:06 +0000 |
| commit | 729b25ea1270344a2ad168f272fd68f53256b661 (patch) | |
| tree | ccb4e951fd68be9205479828def7b76fdd29bebf /docs | |
| parent | 9894b5fca418879ec472e5efbb43be26995e4045 (diff) | |
Improve documentation for FP rounding mode, add bibliography (#6343)
Co-authored-by: Aina Niemetz <aina.niemetz@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/cpp/roundingmode.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/references.bib | 8 | ||||
| -rw-r--r-- | docs/references.rst | 4 |
5 files changed, 20 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5713d3fa3..fbe0e9131 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,9 +29,12 @@ author = 'The Authors of cvc5' # ones. extensions = [ 'breathe', - 'sphinx.ext.autosectionlabel' + 'sphinx.ext.autosectionlabel', + 'sphinxcontrib.bibtex', ] +bibtex_bibfiles = ['references.bib'] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/cpp/roundingmode.rst b/docs/cpp/roundingmode.rst index 83e2e003a..fb7a01d79 100644 --- a/docs/cpp/roundingmode.rst +++ b/docs/cpp/roundingmode.rst @@ -1,10 +1,10 @@ RoundingMode ============ +.. doxygenenum:: cvc5::api::RoundingMode + :project: cvc5 + .. doxygenstruct:: cvc5::api::RoundingModeHashFunction :project: cvc5 :members: :undoc-members: - -.. doxygenenum:: cvc5::api::RoundingMode - :project: cvc5 diff --git a/docs/index.rst b/docs/index.rst index b6eb7edac..af8eb498f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,3 +16,4 @@ cvc5 API Documentation :maxdepth: 2 cpp + references diff --git a/docs/references.bib b/docs/references.bib new file mode 100644 index 000000000..50e410e7b --- /dev/null +++ b/docs/references.bib @@ -0,0 +1,8 @@ +@article{IEEE754, + author={IEEE}, + journal={IEEE Std 754-2019 (Revision of IEEE 754-2008)}, + title={{IEEE Standard for Floating-Point Arithmetic}}, + year={2019}, + pages={1-84}, + doi={10.1109/IEEESTD.2019.8766229} +} diff --git a/docs/references.rst b/docs/references.rst new file mode 100644 index 000000000..7a02493ba --- /dev/null +++ b/docs/references.rst @@ -0,0 +1,4 @@ +References +========== + +.. bibliography::
\ No newline at end of file |