Fix documentation build

This commit is contained in:
Luke Murphy 2019-11-03 16:28:47 +01:00
parent 16d2ed16d9
commit 9140bbe658
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
2 changed files with 25 additions and 1 deletions

View File

@ -2,7 +2,7 @@ Flat_Tree 0.0.1a3 (2019-07-01)
==============================
Improved Documentation
--------
----------------------
- Use the sphinx_rtd_theme.
- 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