Browse Source

keys.rst + editted identation on index

Rener Oliveira (Ubuntu WSL) 1 year ago
parent
commit
c89b2f5bd6
4 changed files with 156 additions and 6 deletions
  1. 9 6
      docs/index.rst
  2. 22 0
      docs/keys.rst
  3. 89 0
      docs/pke_enums.rst
  4. 36 0
      docs/requirements.txt

+ 9 - 6
docs/index.rst

@@ -16,9 +16,12 @@ while keeping the efficiency of C++ FHE operations.
 .. toctree::
    :maxdepth: 1
    :caption: API Reference:
-      cryptocontext
-      ciphertext
-      plaintext
-      pke_enums
-      binfhe
-      binfhe_enums
+   
+   cryptocontext
+   ciphertext
+   plaintext
+   keys
+   pke_enums
+   binfhe
+   binfhe_enums
+

+ 22 - 0
docs/keys.rst

@@ -0,0 +1,22 @@
+Public Key
+===========
+
+.. autoclass:: openfhe.PublicKey
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Private Key
+===========
+.. autoclass:: openfhe.PrivateKey
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+KeyPair
+=======
+.. autoclass:: openfhe.KeyPair
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

+ 89 - 0
docs/pke_enums.rst

@@ -0,0 +1,89 @@
+PKE enums
+=============
+
+Scheme Types 
+#############
+
+.. autoclass:: openfhe.SCHEME
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PKE Scheme Features
+####################
+.. autoclass:: openfhe.PKESchemeFeature
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Scaling Techniques
+####################
+.. autoclass:: openfhe.ScalingTechnique
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Key Switching Techniques
+########################
+.. autoclass:: openfhe.KeySwitchTechnique
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Secret Key Dist
+################
+.. autoclass:: openfhe.SecretKeyDist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Proxy Reencryption Mode
+#######################
+.. autoclass:: openfhe.ProxyReEncryptionMode
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Multiparty Mode
+###############
+.. autoclass:: openfhe.MultipartyMode
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Execution Mode
+###############
+.. autoclass:: openfhe.ExecutionMode
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Decryption Noise Mode
+######################
+.. autoclass:: openfhe.DecryptionNoiseMode
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Encryption Technique
+#####################
+.. autoclass:: openfhe.EncryptionTechnique
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Multiplication Technique
+#########################
+.. autoclass:: openfhe.MultiplicationTechnique
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Security Level
+###############
+.. autoclass:: openfhe.SecurityLevel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+"""

+ 36 - 0
docs/requirements.txt

@@ -0,0 +1,36 @@
+alabaster==0.7.12
+Babel==2.9.1
+breathe==4.33.1
+certifi==2021.10.8
+charset-normalizer==2.0.12
+docutils==0.17.1
+exhale>=0.3.0
+idna==3.3
+imagesize==1.3.0
+importlib-metadata>=4.0.0
+Jinja2==3.0.3
+MarkupSafe>=2.0.0
+packaging==21.3
+pybind11=2.10.3
+pybind11-global=2.10.3
+Pygments==2.11.2
+pyparsing==3.0.7
+pytz==2021.3
+requests==2.27.1
+snowballstemmer==2.2.0
+Sphinx==4.4.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-mermaid==0.7.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+tk=8.6.12
+tomli=1.2.2
+typing-extensions=4.7.1
+urllib3=2.0.4
+wheel=0.38.4
+xz=5.2.6
+zipp=3.16.2