This is an automated email from the ASF dual-hosted git repository.
jmalkin pushed a commit to branch python-docs
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
The following commit(s) were added to refs/heads/python-docs by this push:
new 92b3388 Remove leading underscore from package name since the python
package name also works
new 1917d64 Merge branch 'python-docs' of
github.com:apache/datasketches-cpp into python-docs
92b3388 is described below
commit 92b3388a7b832a14c5282d35c3a91e72443e6e69
Author: Jon <[email protected]>
AuthorDate: Fri Jul 28 12:14:22 2023 -0700
Remove leading underscore from package name since the python package name
also works
---
python/docs/source/conf.py | 7 +++++++
python/docs/source/cpc.rst | 2 +-
python/docs/source/frequent_items.rst | 4 ++--
python/docs/source/hyper_log_log.rst | 2 +-
python/docs/source/index.rst | 3 ---
python/docs/source/kll.rst | 8 ++++----
python/docs/source/theta.rst | 2 +-
7 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/python/docs/source/conf.py b/python/docs/source/conf.py
index aedd563..96f6dfa 100644
--- a/python/docs/source/conf.py
+++ b/python/docs/source/conf.py
@@ -32,6 +32,13 @@ extensions = ["sphinx.ext.autodoc","sphinx.ext.autosummary"]
templates_path = ['_templates']
exclude_patterns = []
+autodoc_default_options = {
+ 'members': True,
+ 'member-order': 'bysource',
+ 'special-members': '__init__',
+ 'undoc-members': True,
+ 'exclude-members': '__weakref__'
+}
# -- Options for HTML output -------------------------------------------------
diff --git a/python/docs/source/cpc.rst b/python/docs/source/cpc.rst
index ac18638..7aa0db1 100644
--- a/python/docs/source/cpc.rst
+++ b/python/docs/source/cpc.rst
@@ -2,6 +2,6 @@ Compressed Probabilistic Counting (CPC)
---------------------------------------
The *Compressed Probabilistic Counting* sketch is a space-efficient method for
estimating cardinalities of sets.
-.. autoclass:: _datasketches.cpc_sketch
+.. autoclass:: datasketches.cpc_sketch
:members:
:undoc-members:
diff --git a/python/docs/source/frequent_items.rst
b/python/docs/source/frequent_items.rst
index c5f40fc..f2460ea 100644
--- a/python/docs/source/frequent_items.rst
+++ b/python/docs/source/frequent_items.rst
@@ -1,6 +1,6 @@
Frequent Items
------------
+--------------
-.. autoclass:: _datasketches.frequent_items_sketch
+.. autoclass:: datasketches.frequent_items_sketch
:members:
:undoc-members:
diff --git a/python/docs/source/hyper_log_log.rst
b/python/docs/source/hyper_log_log.rst
index 7253d9e..f4fce05 100644
--- a/python/docs/source/hyper_log_log.rst
+++ b/python/docs/source/hyper_log_log.rst
@@ -2,6 +2,6 @@ HyperLogLog
-----------
The HyperLogLog sketch is a space-efficient method for estimating
cardinalities of sets.
-.. autoclass:: _datasketches.hll_sketch
+.. autoclass:: datasketches.hll_sketch
:members:
:undoc-members:
diff --git a/python/docs/source/index.rst b/python/docs/source/index.rst
index ac8396c..b075a56 100644
--- a/python/docs/source/index.rst
+++ b/python/docs/source/index.rst
@@ -54,9 +54,6 @@ Indices and tables
.. .. automodule:: datasketches
.. :members:
-.. .. automodule:: _datasketches
-.. :members:
-
..
..
diff --git a/python/docs/source/kll.rst b/python/docs/source/kll.rst
index 312fd34..02944bb 100644
--- a/python/docs/source/kll.rst
+++ b/python/docs/source/kll.rst
@@ -1,19 +1,19 @@
KLL Sketch
----------
-.. autoclass:: _datasketches.kll_ints_sketch
+.. autoclass:: datasketches.kll_ints_sketch
:members:
:undoc-members:
-.. autoclass:: _datasketches.kll_floats_sketch
+.. autoclass:: datasketches.kll_floats_sketch
:members:
:undoc-members:
-.. autoclass:: _datasketches.kll_doubles_sketch
+.. autoclass:: datasketches.kll_doubles_sketch
:members:
:undoc-members:
-.. autoclass:: _datasketches.kll_items_sketch
+.. autoclass:: datasketches.kll_items_sketch
:members:
:undoc-members:
diff --git a/python/docs/source/theta.rst b/python/docs/source/theta.rst
index bf85d9f..2412b49 100644
--- a/python/docs/source/theta.rst
+++ b/python/docs/source/theta.rst
@@ -3,6 +3,6 @@ Theta Sketch
The *Theta Sketch* sketch is a space-efficient method for estimating
cardinalities of sets.
It can also easily handle set operations (such as union, intersection,
difference) while maintaining good accuarcy.
-.. autoclass:: _datasketches.theta_sketch
+.. autoclass:: datasketches.theta_sketch
:members:
:undoc-members:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
