flat-tree implementation coming down the tubes

documentation/Makefile

@@ -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)

documentation/source/changelog.rst

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

documentation/source/code-of-conduct.rst

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

documentation/source/conf.py

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

documentation/source/contribute.rst

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

documentation/source/index.rst

@@ -0,0 +1,14 @@
+.. include:: ../../README.rst
+   :end-before: _documentation
+
+Table of Contents
+*****************
+
+.. toctree::
+
+   install
+   modules-api
+   other-impls
+   contribute
+   changelog
+   code-of-conduct

documentation/source/install.rst

@@ -0,0 +1,11 @@
+*******
+Install
+*******
+
+.. code-block:: bash
+
+    $ pip install flat_tree
+
+.. note::
+
+    Only Python >= 3.6 is supported.

documentation/source/modules-api.rst

@@ -0,0 +1,9 @@
+***********
+Modules API
+***********
+
+.. automodule:: flat_tree.accessor
+   :members:
+
+.. automodule:: flat_tree.iterator
+   :members:

documentation/source/other-impls.rst

@@ -0,0 +1,9 @@
+.. _other-implementations:
+
+Other Implementations
+*********************
+
+* https://github.com/mafintosh/flat-tree
+* https://github.com/datrs/flat-tree
+* https://github.com/bcomnes/flattree
+* https://github.com/datcxx/flat-tree