Initialise the new module boilerplate
This commit is contained in:
12
documentation/Makefile
Normal file
12
documentation/Makefile
Normal 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)
|
0
documentation/source/_static/.git-dont-delete
Normal file
0
documentation/source/_static/.git-dont-delete
Normal file
0
documentation/source/_templates/.git-dont-delete
Normal file
0
documentation/source/_templates/.git-dont-delete
Normal file
5
documentation/source/changelog.rst
Normal file
5
documentation/source/changelog.rst
Normal file
@ -0,0 +1,5 @@
|
||||
*********
|
||||
Changelog
|
||||
*********
|
||||
|
||||
.. include:: ../../CHANGELOG.rst
|
1
documentation/source/code-of-conduct.rst
Normal file
1
documentation/source/code-of-conduct.rst
Normal file
@ -0,0 +1 @@
|
||||
.. include:: ../../CODE_OF_CONDUCT.rst
|
7
documentation/source/conf.py
Normal file
7
documentation/source/conf.py
Normal file
@ -0,0 +1,7 @@
|
||||
author = 'decentral1se'
|
||||
copyright = '2019, decentral1se'
|
||||
html_static_path = ['_static']
|
||||
html_theme = 'alabaster'
|
||||
master_doc = 'index'
|
||||
project = 'merkle-tree-stream'
|
||||
templates_path = ['_templates']
|
1
documentation/source/contribute.rst
Normal file
1
documentation/source/contribute.rst
Normal file
@ -0,0 +1 @@
|
||||
.. include:: ../../CONTRIBUTING.rst
|
12
documentation/source/index.rst
Normal file
12
documentation/source/index.rst
Normal file
@ -0,0 +1,12 @@
|
||||
.. include:: ../../README.rst
|
||||
:end-before: _documentation
|
||||
|
||||
Contents:
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
|
||||
install
|
||||
contribute
|
||||
changelog
|
||||
code-of-conduct
|
11
documentation/source/install.rst
Normal file
11
documentation/source/install.rst
Normal file
@ -0,0 +1,11 @@
|
||||
************
|
||||
Installation
|
||||
************
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install merkle-tree-stream
|
||||
|
||||
.. note::
|
||||
|
||||
This tool only supports Python >= 3.6.
|
Reference in New Issue
Block a user