Use more standard docs folder

This commit is contained in:
Luke Murphy
2019-11-25 11:20:13 +07:00
parent 3d9cc598e4
commit afa26f35cf
15 changed files with 8 additions and 2 deletions
+12
View File
@@ -0,0 +1,12 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+5
View File
@@ -0,0 +1,5 @@
*********
Changelog
*********
.. include:: ../../CHANGELOG.rst
+6
View File
@@ -0,0 +1,6 @@
.. _code-of-conduct:
Code of Conduct
***************
.. include:: ../../CODE_OF_CONDUCT.rst
+8
View File
@@ -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']
+5
View File
@@ -0,0 +1,5 @@
**********
Contribute
**********
.. include:: ../../CONTRIBUTING.rst
+24
View File
@@ -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')
+15
View File
@@ -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
+11
View File
@@ -0,0 +1,11 @@
*******
Install
*******
.. code-block:: bash
$ pip install merkle-tree-stream
.. note::
This tool only supports Python >= 3.6.
+11
View File
@@ -0,0 +1,11 @@
.. _modules_api:
***********
Modules API
***********
.. automodule:: merkle_tree_stream.tree
:members:
.. automodule:: merkle_tree_stream.node
:members:
+12
View File
@@ -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
+7
View File
@@ -0,0 +1,7 @@
*******
Upgrade
*******
.. code-block:: bash
$ pip install --upgrade merkle-tree-stream