#97: missing doc for crypto parameters

arcturusannamalai · arcturusannamalai · commit 233c893aad41 · 2024-05-27T02:50:28.000Z
- add cryptoparams to sphinx docs
diff --git a/docs/cryptoparams.rst b/docs/cryptoparams.rst
@@ -0,0 +1,24 @@
+CryptoParams
+============
+
+The following crypto parameter objects are available per scheme **BFV**, **BGV** and **CKKS** respectively.
+
+CyrptoParamsBFVRNS
+##################
+.. autoclass:: openfhe.CCParamsBFVRNS
+    :members:
+    :show-inheritance:
+
+CryptoParamsBGVRNS
+##################
+.. autoclass:: openfhe.CCParamsBGVRNS
+    :members:
+    :show-inheritance:
+
+	       
+CryptoParamsCKKSRNS
+###################
+.. autoclass:: openfhe.CCParamsCKKSRNS
+    :members:
+    :show-inheritance:
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,10 +14,11 @@ Fully Homomorphic Encryption (FHE) is a powerful cryptographic primitive that en
 while keeping the efficiency of C++ FHE operations.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 3
    :caption: API Reference:
    
    cryptocontext
+   cryptoparams
    ciphertext
    plaintext
    keys
