diff options
author | Joshua Harlow <harlowja@gmail.com> | 2014-12-09 00:06:10 -0800 |
---|---|---|
committer | Joshua Harlow <harlowja@gmail.com> | 2014-12-09 21:25:20 -0800 |
commit | 836fec02da5af5d53ac1852720d3a10cbfff59d2 (patch) | |
tree | 23bb2a2a1cc5a5858a520b2260751131c0a26e8c | |
parent | 14000cd9f2e4a090ccbf7415aae4a1950cae72eb (diff) | |
download | tooz-836fec02da5af5d53ac1852720d3a10cbfff59d2.tar.gz |
Add driver autogenerated docs
Start to add/build a developer oriented doc that
can be further refined to explain to developers how
to use the different tooz drivers (and what the varying
drivers capabilities are).
Change-Id: I49f6bf5b397d6bc5426c074f6196c764c8938d23
-rw-r--r-- | doc/source/conf.py | 2 | ||||
-rw-r--r-- | doc/source/developers.rst | 54 | ||||
-rw-r--r-- | doc/source/index.rst | 1 | ||||
-rw-r--r-- | tooz/drivers/ipc.py | 1 | ||||
-rw-r--r-- | tooz/drivers/memcached.py | 1 | ||||
-rw-r--r-- | tooz/drivers/mysql.py | 1 | ||||
-rw-r--r-- | tooz/drivers/pgsql.py | 1 |
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 661438f..1a4f78b 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.""" |