This is an automated email from the ASF dual-hosted git repository.
charlie 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 8569dd9 Added readme and fixed warnings
8569dd9 is described below
commit 8569dd97bd8abdf0d7c9b8f00c6eccc7a1e08324
Author: Charlie Dickens <[email protected]>
AuthorDate: Fri Jul 28 10:19:03 2023 -0700
Added readme and fixed warnings
---
python/docs/README.md | 18 ++++++++++++++++++
python/docs/source/frequent_items.rst | 2 +-
2 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/python/docs/README.md b/python/docs/README.md
new file mode 100644
index 0000000..113276f
--- /dev/null
+++ b/python/docs/README.md
@@ -0,0 +1,18 @@
+Follow these steps to build the documentation.
+1. Clone the directory in an appropriate location `git clone
https://github.com/apache/datasketches-cpp.git` and navigate into
`datasketches-cpp`.
+2. Switch to the correct branch: `git checkout python-docs`.
+3. *Either in a new virtual environment, or your current environment, install
sphinx and datasketches via*
+(nb my environment has python aliased to python3 so just use whichever is
appropriate for your installation)
+```
+python -m venv python-docs-venv # create a new virtual env named
python-docs-venv
+source python-docs-venv/bin/activate
+python -m pip install sphinx
+python -m pip install sphinx-rtd-theme
+```
+4. In project root run `python3 -m pip install .` to build the python bindings.
+5. Build and open the documentation:
+```
+cd python/docs
+make html
+open build/html/index.html
+```
diff --git a/python/docs/source/frequent_items.rst
b/python/docs/source/frequent_items.rst
index c5f40fc..c755d56 100644
--- a/python/docs/source/frequent_items.rst
+++ b/python/docs/source/frequent_items.rst
@@ -1,5 +1,5 @@
Frequent Items
------------
+--------------
.. autoclass:: _datasketches.frequent_items_sketch
:members:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
