diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/btree.rst | 7 | ||||
| -rw-r--r-- | doc/codec.rst | 7 | ||||
| -rw-r--r-- | doc/forest.rst | 7 | ||||
| -rw-r--r-- | doc/index.rst | 24 | ||||
| -rw-r--r-- | doc/node.rst | 7 | ||||
| -rw-r--r-- | doc/nodestore.rst | 7 | ||||
| -rw-r--r-- | doc/refcountstore.rst | 7 | ||||
| -rw-r--r-- | doc/uploadqueue.rst | 7 |
8 files changed, 67 insertions, 6 deletions
diff --git a/doc/btree.rst b/doc/btree.rst new file mode 100644 index 0000000..1c6e8f3 --- /dev/null +++ b/doc/btree.rst @@ -0,0 +1,7 @@ +Individual trees +================ + +.. automodule:: larch.tree + :members: + :undoc-members: + diff --git a/doc/codec.rst b/doc/codec.rst new file mode 100644 index 0000000..659375c --- /dev/null +++ b/doc/codec.rst @@ -0,0 +1,7 @@ +Node codecs +=========== + +.. automodule:: larch.codec + :members: + :undoc-members: + diff --git a/doc/forest.rst b/doc/forest.rst new file mode 100644 index 0000000..8903957 --- /dev/null +++ b/doc/forest.rst @@ -0,0 +1,7 @@ +Forests of trees +================ + +.. automodule:: larch.forest + :members: + :undoc-members: + diff --git a/doc/index.rst b/doc/index.rst index d924ea4..8f7974d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -21,6 +21,24 @@ for on-disk storage. * Rodeh paper: http://liw.fi/larch/ohad-btrees-shadowing-clones.pdf +Classes and functions +===================== + +Anything that is available as ``larch.foo.bar`` is also +available as ``larch.bar``. + +.. toctree:: + :maxdepth: 2 + + forest + btree + node + codec + nodestore + refcountstore + uploadqueue + + Quick start =========== @@ -83,12 +101,6 @@ You probably don't need to worry about anything else than the ``Forest`` and ``BTree`` classes, unless you want to provide your own ``NodeStore`` instance. -Reference manual -================ - -.. automodule:: larch - :members: - :undoc-members: Indices and tables diff --git a/doc/node.rst b/doc/node.rst new file mode 100644 index 0000000..9a2b815 --- /dev/null +++ b/doc/node.rst @@ -0,0 +1,7 @@ +Individual nodes +================ + +.. automodule:: larch.nodes + :members: + :undoc-members: + diff --git a/doc/nodestore.rst b/doc/nodestore.rst new file mode 100644 index 0000000..a3a2237 --- /dev/null +++ b/doc/nodestore.rst @@ -0,0 +1,7 @@ +Node storage +============ + +.. automodule:: larch.nodestore + :members: + :undoc-members: + diff --git a/doc/refcountstore.rst b/doc/refcountstore.rst new file mode 100644 index 0000000..a8ccfa7 --- /dev/null +++ b/doc/refcountstore.rst @@ -0,0 +1,7 @@ +Reference count storage +======================= + +.. automodule:: larch.refcountstore + :members: + :undoc-members: + diff --git a/doc/uploadqueue.rst b/doc/uploadqueue.rst new file mode 100644 index 0000000..15f33b1 --- /dev/null +++ b/doc/uploadqueue.rst @@ -0,0 +1,7 @@ +Upload queue for nodes +====================== + +.. automodule:: larch.uploadqueue + :members: + :undoc-members: + |