Merge pull request #7 from apache/docs-update

Added tuple and density to docs
apache · Sep 12, 2023 · 893d83c · 893d83c
2 parents 6d8b636 + 044c93d
commit 893d83c
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -8,6 +8,7 @@
 
 import sys
 import os 
+import datasketches
 
 # need to fix the paths so that sphinx can find the source code.
 sys.path.insert(0, os.path.abspath("../../datasketches"))

diff --git a/docs/source/density_sketch.rst b/docs/source/density_sketch.rst
@@ -0,0 +1,8 @@
+Density Sketch
+--------------
+.. autoclass:: datasketches.density_sketch
+    :members:
+    :undoc-members:
+
+.. autoclass:: datasketches.GaussianKernel
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,6 +19,14 @@ Counting Distincts
    hyper_log_log
    cpc
    theta 
+   tuple
+
+Density Sketch
+##############
+.. toctree::
+   :maxdepth: 1 
+
+   density_sketch
 
 Frequency Estimation
 ##########################

diff --git a/docs/source/tuple.rst b/docs/source/tuple.rst
@@ -0,0 +1,15 @@
+Tuple Sketch
+------------
+
+.. autoclass:: datasketches.tuple_sketch
+    :members:
+    :undoc-members:
+
+.. autoclass:: datasketches.AccumulatorPolicy        
+    :members:    
+
+.. autoclass:: datasketches.MaxIntPolicy        
+    :members:    
+
+.. autoclass:: datasketches.MinIntPolicy        
+    :members: