Follow these steps to build the documentation.
git clone https://github.com/apache/datasketches-python.gitcd datasketches-python git branch new-branch git checkout new-branch
python or python3, as indicated by python(3).python -m venv venv # create a new virtual env named venv using system python source venv/bin/activate python(3) -m pip install sphinx # now using venv python python(3) -m pip install sphinx-rtd-theme
python(3) -m pip install . to build the python bindings.cd python/docs make html open build/html/index.html
The density_sketch and tuple_sketch are not yet included.
I have not included the file to avoid cluttering the PR with things that may not work. You can easily include them by making a density_sketch.rst file in the same location as all of the other X.rst files for the sketches and copying in the following:
Density Sketch
--------------
.. autoclass:: datasketches.density_sketch
:members:
:undoc-members:
.. autoclass:: datasketches.GaussianKernel
:members:
Additionally, you will need to add the below to index.rst
Density Estimation ################## .. toctree:: :maxdepth: 1 density_sketch