rearrange existing documentation to fit the new standard layout

Change-Id: If03b33fc1393c3a04d7d155b31e8377dc9e09360

16 files changed, 33 insertions, 32 deletions

diff --git a/doc/source/history.rst b/doc/source/history.rst
deleted file mode 100644
index 69ed4fe..0000000
--- a/doc/source/history.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../ChangeLog
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8bb1c84..af18503 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,28 +6,14 @@ The Tooz project aims at centralizing the most common distributed primitives
 like group membership protocol, lock service and leader election by providing
 a coordination API helping developers to build distributed applications. [#f1]_
 
-Contents
-========
-
-.. toctree::
-   :glob:
-
-   install
-   drivers
-   compatibility
-   tutorial/index
-   developers
-
-Release Notes
-=============
-
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   history
+   install/index
+   user/index
+   reference/index
 
-Indices and tables
-==================
+.. rubric:: Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/doc/source/install.rst b/doc/source/install/index.rst
index 3070b4a..3070b4a 100644
--- a/doc/source/install.rst
+++ b/doc/source/install/index.rst
diff --git a/doc/source/developers.rst b/doc/source/reference/index.rst
index 57ccbec..15b7d57 100644
--- a/doc/source/developers.rst
+++ b/doc/source/reference/index.rst
@@ -1,6 +1,6 @@
-==========
-Developers
-==========
+================
+Module Reference
+================
 
 Interfaces
 ----------
diff --git a/doc/source/compatibility.rst b/doc/source/user/compatibility.rst
index 975bedb..975bedb 100644
--- a/doc/source/compatibility.rst
+++ b/doc/source/user/compatibility.rst
diff --git a/doc/source/drivers.rst b/doc/source/user/drivers.rst
index 3d3fdd3..3d3fdd3 100644
--- a/doc/source/drivers.rst
+++ b/doc/source/user/drivers.rst
diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst
new file mode 100644
index 0000000..f69be70
--- /dev/null
+++ b/doc/source/user/history.rst
@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..7ab2c1a
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,15 @@
+==================
+User Documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   tutorial/index
+   drivers
+   compatibility
+
+.. toctree::
+   :maxdepth: 1
+
+   history
diff --git a/doc/source/tutorial/coordinator.rst b/doc/source/user/tutorial/coordinator.rst
index faf9ab2..0131dee 100644
--- a/doc/source/tutorial/coordinator.rst
+++ b/doc/source/user/tutorial/coordinator.rst
@@ -17,7 +17,7 @@ If a driver does not support a feature, it will raise a
 This example program loads a basic coordinator using the ZooKeeper based
 driver.
 
-.. literalinclude:: ../../../examples/coordinator.py
+.. literalinclude:: ../../../../examples/coordinator.py
    :language: python
 
 The second argument passed to the coordinator must be a unique identifier
@@ -33,7 +33,7 @@ other program participating in the coordination. Unless you want to call it
 manually, you can use tooz builtin heartbeat manager by passing the
 `start_heart` argument.
 
-.. literalinclude:: ../../../examples/coordinator_heartbeat.py
+.. literalinclude:: ../../../../examples/coordinator_heartbeat.py
    :language: python
 
 heartbeat at different moment or intervals.
diff --git a/doc/source/tutorial/group_membership.rst b/doc/source/user/tutorial/group_membership.rst
index d16da8c..502d211 100644
--- a/doc/source/tutorial/group_membership.rst
+++ b/doc/source/user/tutorial/group_membership.rst
@@ -10,7 +10,7 @@ group membership. Once a group is created, any coordinator can join the
 group and become a member of it. Any coordinator can be notified when a
 members joins or leaves the group.
 
-.. literalinclude:: ../../../examples/group_membership.py
+.. literalinclude:: ../../../../examples/group_membership.py
    :language: python
 
 Note that all the operation are asynchronous. That means you cannot be sure
@@ -29,7 +29,7 @@ changes. That's useful to run callback functions whenever something happens
 in that group.
 
 
-.. literalinclude:: ../../../examples/group_membership_watch.py
+.. literalinclude:: ../../../../examples/group_membership_watch.py
    :language: python
 
 Using :meth:`tooz.coordination.CoordinationDriver.watch_join_group` and
diff --git a/doc/source/tutorial/hashring.rst b/doc/source/user/tutorial/hashring.rst
index 0adc573..1e00d1f 100644
--- a/doc/source/tutorial/hashring.rst
+++ b/doc/source/user/tutorial/hashring.rst
@@ -6,5 +6,5 @@ Tooz provides a consistent hash ring implementation. It can be used to map
 objects (represented via binary keys) to one or several nodes. When the node
 list changes, the rebalancing of objects across the ring is kept minimal.
 
-.. literalinclude:: ../../../examples/hashring.py
+.. literalinclude:: ../../../../examples/hashring.py
    :language: python
diff --git a/doc/source/tutorial/index.rst b/doc/source/user/tutorial/index.rst
index c2d398c..c2d398c 100644
--- a/doc/source/tutorial/index.rst
+++ b/doc/source/user/tutorial/index.rst
diff --git a/doc/source/tutorial/leader_election.rst b/doc/source/user/tutorial/leader_election.rst
index 052e6c3..df2a77b 100644
--- a/doc/source/tutorial/leader_election.rst
+++ b/doc/source/user/tutorial/leader_election.rst
@@ -7,7 +7,7 @@ in a group. Only members that are running for the election can be elected.
 As soon as one of leader steps down or dies, a new member that was running
 for the election will be elected.
 
-.. literalinclude:: ../../../examples/leader_election.py
+.. literalinclude:: ../../../../examples/leader_election.py
    :language: python
 
 The method
diff --git a/doc/source/tutorial/lock.rst b/doc/source/user/tutorial/lock.rst
index cf34d52..e3aaaae 100644
--- a/doc/source/tutorial/lock.rst
+++ b/doc/source/user/tutorial/lock.rst
@@ -5,7 +5,7 @@
 Tooz provides distributed locks. A lock is identified by a name, and a lock can
 only be acquired by one coordinator at a time.
 
-.. literalinclude:: ../../../examples/lock.py
+.. literalinclude:: ../../../../examples/lock.py
    :language: python
 
 The method :meth:`tooz.coordination.CoordinationDriver.get_lock` allows
diff --git a/doc/source/tutorial/partitioner.rst b/doc/source/user/tutorial/partitioner.rst
index d8547b8..24e12cf 100644
--- a/doc/source/tutorial/partitioner.rst
+++ b/doc/source/user/tutorial/partitioner.rst
@@ -7,5 +7,5 @@ implementation. It can be used to map Python objects to one or several nodes.
 The partitioner object automatically keeps track of nodes joining and leaving
 the group, so the rebalancing is managed.
 
-.. literalinclude:: ../../../examples/partitioner.py
+.. literalinclude:: ../../../../examples/partitioner.py
    :language: python
diff --git a/tox.ini b/tox.ini
index 2f5bcf2..49a0fb3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -60,7 +60,7 @@ show-source = True
 
 [doc8]
 
-ignore-path = doc/source/compatibility.rst,doc/source/history.rst
+ignore-path = doc/source/user/compatibility.rst,doc/source/history.rst
 
 
 [testenv:releasenotes]