Skip to content

Commit

Permalink
add and fix indicies at bottom of pages
Browse files Browse the repository at this point in the history
  • Loading branch information
barrust committed Jul 14, 2017
1 parent a90795a commit 81030d8
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
10 changes: 7 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ PyProbables
is to provide the developer with a pure-python implementation of common
probabilistic data-structures to use in their work.


Installation
------------------

Expand All @@ -25,11 +26,12 @@ To install `pyprobables`, simply clone the `repository on GitHub

`pyprobables` supports python versions 2.7 and 3.3 - 3.6


API Documentation
---------------------

The documentation of is hosted on
`readthedocs.io <http://pyprobables.readthedocs.io/en/stable/code.html#api>`__
`readthedocs.io <http://pyprobables.readthedocs.io/en/latest/code.html#api>`__

You can build the documentation yourself by running:

Expand All @@ -52,6 +54,7 @@ downloaded folder:
$ python setup.py test



Quickstart
------------------

Expand All @@ -75,11 +78,12 @@ Import pyprobables and setup a Count-Min Sketch:
>>> cms.add('google.com') # should return 1
>>> cms.add('facebook.com', 25) # insert 25 at once; should return 25
See the `API documentation <http://pyprobables.readthedocs.io/en/stable/code.html#api>`__
See the `API documentation <http://pyprobables.readthedocs.io/en/latest/code.html#api>`__
for other data structures available and the
`quickstart page <http://pyprobables.readthedocs.io/en/stable/quickstart.html#quickstart>`__
`quickstart page <http://pyprobables.readthedocs.io/en/latest/quickstart.html#quickstart>`__
for more examples!


Changelog
------------------

Expand Down
7 changes: 5 additions & 2 deletions docs/source/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ in data analytics and data science projects.
code



Data Structures and Classes
===============================

Expand Down Expand Up @@ -45,7 +44,8 @@ Count-Min Sketches
------------------

Count-Min Sketches are a class of probabilistic data structures designed to
count the number of occurrences of data elements in data streams.
count the number of occurrences of data elements in data streams.


CountMinSketch
+++++++++++++++++++++++++++++++
Expand All @@ -61,13 +61,15 @@ HeavyHitters
:members:
:inherited-members:


StreamThreshold
+++++++++++++++++++++++++++++++

.. autoclass:: probables.StreamThreshold
:members:
:inherited-members:


Exceptions
===============================

Expand All @@ -81,6 +83,7 @@ Hashing Functions
.. automodule:: probables.hashes
:members:


Indices and tables
==================

Expand Down
10 changes: 10 additions & 0 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,13 @@ Stream Threshold
Heavy Hitters. The main difference is that the there is a threshold for
including an element to be tracked instead of tracking a certain number of
elements.


Indices and tables
==================

* :ref:`home`
* :ref:`api`
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 81030d8

Please sign in to comment.