From 38e4cf3fe6dd8f171657943155e875c180649e15 Mon Sep 17 00:00:00 2001 From: Gereon Kremer Date: Tue, 23 Nov 2021 12:59:26 -0800 Subject: [PATCH] Add kinds to python docs (#7672) This PR adds the kinds to the documentation for the regular python docs. --- docs/api/python/regular/kind.rst | 12 ++++++++++++ docs/api/python/regular/python.rst | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/api/python/regular/kind.rst diff --git a/docs/api/python/regular/kind.rst b/docs/api/python/regular/kind.rst new file mode 100644 index 000000000..f2dd8550b --- /dev/null +++ b/docs/api/python/regular/kind.rst @@ -0,0 +1,12 @@ +Kind +================ + +Every :py:class:`Term ` has a kind which represents its type, for +example whether it is an equality (:py:obj:`Equal `), a +conjunction (:py:obj:`And `), or a bit-vector addtion +(:py:obj:`BVAdd `). +The kinds below directly correspond to the enum values of the C++ :cpp:enum:`Kind ` enum. + +.. autoclass:: pycvc5.kinds + :members: + :undoc-members: diff --git a/docs/api/python/regular/python.rst b/docs/api/python/regular/python.rst index 2e50f2d68..b054cbe16 100644 --- a/docs/api/python/regular/python.rst +++ b/docs/api/python/regular/python.rst @@ -17,6 +17,7 @@ Python API Documentation datatypedecl datatypeselector grammar + kind op result roundingmode -- 2.30.2