Fix documentation build
This commit is contained in:
parent
16d2ed16d9
commit
9140bbe658
@ -2,7 +2,7 @@ Flat_Tree 0.0.1a3 (2019-07-01)
|
|||||||
==============================
|
==============================
|
||||||
|
|
||||||
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.
|
||||||
|
24
documentation/source/example.rst
Normal file
24
documentation/source/example.rst
Normal 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
|
Loading…
Reference in New Issue
Block a user