Add kinds to python docs (#7672)

This PR adds the kinds to the documentation for the regular python docs.

diff --git a/docs/api/python/regular/kind.rst b/docs/api/python/regular/kind.rst
new file mode 100644 (file)
index 0000000..f2dd855
--- /dev/null
+++ b/docs/api/python/regular/kind.rst
@@ -0,0 +1,12 @@
+Kind
+================
+
+Every :py:class:`Term <pycvc5.Term>` has a kind which represents its type, for
+example whether it is an equality (:py:obj:`Equal <pycvc5.kinds.Equal>`), a
+conjunction (:py:obj:`And <pycvc5.kinds.And>`), or a bit-vector addtion
+(:py:obj:`BVAdd <pycvc5.kinds.BVAdd>`).
+The kinds below directly correspond to the enum values of the C++ :cpp:enum:`Kind <cvc5::api::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 2e50f2d6830f5e9ede730242d8646e4526e01b7e..b054cbe165392270b2f38cb9a6c42fcaa0768ce1 100644 (file)
--- 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