2 Commits

Author SHA1 Message Date
ff7f671b96 Fix up changelog for new release 2019-11-03 16:30:11 +01:00
9140bbe658 Fix documentation build 2019-11-03 16:28:47 +01:00
2 changed files with 36 additions and 2 deletions

View File

@ -1,8 +1,18 @@
Flat_Tree 0.0.1a3 (2019-07-01) Flat_Tree 0.0.1a5 (2019-11-03)
==============================
Trivial/Internal Changes
------------------------
- Fixed documentation build errors.
- Fixed changelog entry date and version.
Flat_Tree 0.0.1a4 (2019-11-03)
============================== ==============================
Improved Documentation Improved Documentation
-------- ----------------------
- Use the sphinx_rtd_theme. - Use the sphinx_rtd_theme.
- Attempt to clarify sections using better navigation. - Attempt to clarify sections using better navigation.

View File

@ -0,0 +1,24 @@
*******
Example
*******
You can represent a binary tree in a simple flat list using the following structure.
.. code-block:: python
"""
3
1 5
0 2 4 6 ...
"""
This module exposes a series of functions to help you build and maintain this data structure.
.. code-block:: python
from flat_tree import FlatTreeAccessor
tree_access = FlatTreeAccessor()
tree_access.index(1, 0) # get index @ depth: 1, offset: 0