rst files

docs/binfhe.rst

@@ -0,0 +1,21 @@
+BinFHEContext
+----------------
+
+.. autoclass:: openfhe.BinFHEContext
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+LWECiphertext
+----------------
+.. autoclass:: openfhe.LWECiphertext
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    
+LWEPrivateKey
+----------------
+.. autoclass:: openfhe.LWEPrivateKey
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/binfhe_enums.rst

@@ -0,0 +1,31 @@
+BinFHE enums
+=============
+
+Parameter Set
+#############
+
+.. autoclass:: openfhe.BINFHE_PARAMSET
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+BINFHE_METHOD
+#############
+.. autoclass:: openfhe.BINFHE_METHOD
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+BinFHE Output
+#############
+.. autoclass:: openfhe.BINFHE_OUTPUT
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Binary Gates
+#############
+.. autoclass:: openfhe.BINGATE
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/conf.py

@@ -62,7 +62,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/cryptocontext.rst

@@ -5,6 +5,4 @@ CryptoContext
     :members:
     :undoc-members:
     :show-inheritance:
-
-.. autofunction:: openfhe.CryptoContext.Encrypt
-.. autofunction:: openfhe.CryptoContext.Decrypt
+    :noindex:

docs/index.rst

@@ -6,18 +6,19 @@
 Welcome to OpenFHE - Python's documentation!
 ============================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-      
-   cryptocontext
-   ciphertext
-   plaintext
-
+OpenFHE - Python
+----------------
+Fully Homomorphic Encryption (FHE) is a powerful cryptographic primitive that enables performing computations over encrypted data without having access to the secret key. `OpenFHE <https://openfhe.org/>`_ is an open-source FHE library that includes efficient implementations of all common FHE schemes: BFV, BGV, CKKS, DM and CGGI.
 
-Indices and tables
-==================
+``openfhe-python`` is a Python library built as a wrapper for the main capabilities of OpenFHE C++ library. It provides a more user-friendly interface for Python developers, 
+while keeping the efficiency of C++ FHE operations.
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. toctree::
+   :maxdepth: 1
+   :caption: API Reference:
+      cryptocontext
+      ciphertext
+      plaintext
+      pke_enums
+      binfhe
+      binfhe_enums