Merge "Add driver autogenerated docs"

7 files changed, 61 insertions, 0 deletions

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 16edd3f..9fa2fee 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -31,6 +31,8 @@ extensions = [
     'sphinx.ext.graphviz',
     'sphinx.ext.extlinks',
     'oslosphinx',
+    'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.viewcode',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/doc/source/developers.rst b/doc/source/developers.rst
new file mode 100644
index 0000000..f375e0a
--- /dev/null
+++ b/doc/source/developers.rst
@@ -0,0 +1,54 @@
+==========
+Developers
+==========
+
+Interfaces
+----------
+
+.. autoclass:: tooz.coordination.CoordinationDriver
+   :members:
+
+IPC
+~~~
+
+.. autoclass:: tooz.drivers.ipc.IPCDriver
+   :members:
+
+Memcached
+~~~~~~~~~
+
+.. autoclass:: tooz.drivers.memcached.MemcachedDriver
+   :members:
+
+Mysql
+~~~~~
+
+.. autoclass:: tooz.drivers.mysql.MySQLDriver
+   :members:
+
+PostgreSQL
+~~~~~~~~~~
+
+.. autoclass:: tooz.drivers.pgsql.PostgresDriver
+   :members:
+
+Redis
+~~~~~
+
+.. autoclass:: tooz.drivers.redis.RedisDriver
+   :members:
+
+Zake
+~~~~
+
+.. autoclass:: tooz.drivers.zake.ZakeDriver
+   :members:
+
+Zookeeper
+~~~~~~~~~
+
+.. autoclass:: tooz.drivers.zookeeper.BaseZooKeeperDriver
+   :members:
+
+.. autoclass:: tooz.drivers.zookeeper.KazooDriver
+   :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index da2ae54..c82afed 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -13,6 +13,7 @@ Contents:
    install
    drivers
    tutorial/index
+   developers
 
 Indices and tables
 ==================
diff --git a/tooz/drivers/ipc.py b/tooz/drivers/ipc.py
index 5ab4866..21d8647 100644
--- a/tooz/drivers/ipc.py
+++ b/tooz/drivers/ipc.py
@@ -120,6 +120,7 @@ class IPCLock(locking.Lock):
 
 
 class IPCDriver(coordination.CoordinationDriver):
+    """A IPC based driver."""
 
     def __init__(self, member_id, parsed_url, options):
         """Initialize the IPC driver."""
diff --git a/tooz/drivers/memcached.py b/tooz/drivers/memcached.py
index 779ceb7..ce1ddd9 100644
--- a/tooz/drivers/memcached.py
+++ b/tooz/drivers/memcached.py
@@ -79,6 +79,7 @@ class MemcachedLock(locking.Lock):
 
 
 class MemcachedDriver(coordination.CoordinationDriver):
+    """A memcached based driver."""
 
     _GROUP_PREFIX = b'_TOOZ_GROUP_'
     _GROUP_LEADER_PREFIX = b'_TOOZ_GROUP_LEADER_'
diff --git a/tooz/drivers/mysql.py b/tooz/drivers/mysql.py
index c517a0a..4fdf97b 100644
--- a/tooz/drivers/mysql.py
+++ b/tooz/drivers/mysql.py
@@ -67,6 +67,7 @@ class MySQLLock(locking.Lock):
 
 
 class MySQLDriver(coordination.CoordinationDriver):
+    """A mysql based driver."""
 
     def __init__(self, member_id, parsed_url, options):
         """Initialize the MySQL driver."""
diff --git a/tooz/drivers/pgsql.py b/tooz/drivers/pgsql.py
index 8494066..d1af833 100644
--- a/tooz/drivers/pgsql.py
+++ b/tooz/drivers/pgsql.py
@@ -127,6 +127,7 @@ class PostgresLock(locking.Lock):
 
 
 class PostgresDriver(coordination.CoordinationDriver):
+    """A PostgreSQL based driver."""
 
     def __init__(self, member_id, parsed_url, options):
         """Initialize the PostgreSQL driver."""