Use more standard docs folder

docs/source/changelog.rst

@@ -0,0 +1,5 @@
+*********
+Changelog
+*********
+
+.. include:: ../../CHANGELOG.rst

docs/source/code-of-conduct.rst

@@ -0,0 +1,6 @@
+.. _code-of-conduct:
+
+Code of Conduct
+***************
+
+.. include:: ../../CODE_OF_CONDUCT.rst

docs/source/conf.py

@@ -0,0 +1,8 @@
+author = 'decentral1se'
+copyright = '2019, decentral1se'
+html_static_path = ['_static']
+html_theme = 'sphinx_rtd_theme'
+master_doc = 'index'
+project = 'merkle-tree-stream'
+templates_path = ['_templates']
+extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints']

docs/source/contribute.rst

@@ -0,0 +1,5 @@
+**********
+Contribute
+**********
+
+.. include:: ../../CONTRIBUTING.rst

docs/source/example.rst

@@ -0,0 +1,24 @@
+.. _example:
+
+*******
+Example
+*******
+
+.. code-block:: python
+
+    from hashlib import sha256
+    from merkle_tree_stream import MerkleTreeGenerator
+
+    def leaf(node, roots=None):
+        return sha256(node.data).digest()
+
+    def parent(first, second):
+        sha256 = hashlib.sha256()
+        sha256.update(first.data)
+        sha256.update(second.data)
+        return sha256.digest()
+
+    merkle = MerkleTreeGenerator(leaf=leaf, parent=parent)
+    merkle.write('hello')
+    merkle.write('hashed')
+    merkle.write('world')

docs/source/index.rst

@@ -0,0 +1,15 @@
+.. include:: ../../README.rst
+   :end-before: _documentation
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   install
+   upgrade
+   example
+   modules-api
+   other-impls
+   contribute
+   changelog
+   code-of-conduct

docs/source/install.rst

@@ -0,0 +1,11 @@
+*******
+Install
+*******
+
+.. code-block:: bash
+
+    $ pip install merkle-tree-stream
+
+.. note::
+
+    This tool only supports Python >= 3.6.

docs/source/modules-api.rst

@@ -0,0 +1,11 @@
+.. _modules_api:
+
+***********
+Modules API
+***********
+
+.. automodule:: merkle_tree_stream.tree
+   :members:
+
+.. automodule:: merkle_tree_stream.node
+   :members:

docs/source/other-impls.rst

@@ -0,0 +1,12 @@
+.. _other-implementations:
+
+Other Implementations
+*********************
+
+* `mafintosh/merkle-tree-stream`_
+* `datrs/merkle-tree-stream`_
+* `datcxx/merkle-tree-stream`_
+
+.. _mafintosh/merkle-tree-stream: https://github.com/mafintosh/merkle-tree-stream
+.. _datrs/merkle-tree-stream: https://github.com/datrs/merkle-tree-stream
+.. _datcxx/merkle-tree-stream: https://github.com/datcxx/merkle-tree-stream

docs/source/upgrade.rst

@@ -0,0 +1,7 @@
+*******
+Upgrade
+*******
+
+.. code-block:: bash
+
+    $ pip install --upgrade merkle-tree-stream