diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-07-07 03:21:54 +0000 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-07-10 12:44:29 +0000 |
| commit | ee6f82d9d55b28c8782f3c6afc36d204a68356ac (patch) | |
| tree | b704514d04b87b4003a78e6c5929d0d5475d32b7 | |
| parent | 2ca15fedbec25233240d0cff267c14127d5f6c81 (diff) | |
| download | tooz-ee6f82d9d55b28c8782f3c6afc36d204a68356ac.tar.gz | |
doc: use list-table for driver support tables
list-table is easier to be maintained.
In addition, we avoid too long lines.
We no longer have too long lines which doc8 complains,
so doc8 ignore_path can be dropped.
Change-Id: I574391295288ef9e33744aa608c2f2930a6e46f8
| -rw-r--r-- | doc/source/user/compatibility.rst | 90 | ||||
| -rw-r--r-- | tox.ini | 5 |
2 files changed, 75 insertions, 20 deletions
diff --git a/doc/source/user/compatibility.rst b/doc/source/user/compatibility.rst index 975bedb..6a38c29 100644 --- a/doc/source/user/compatibility.rst +++ b/doc/source/user/compatibility.rst @@ -24,11 +24,31 @@ APIs Driver support -------------- -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -:py:class:`~tooz.drivers.consul.ConsulDriver` :py:class:`~tooz.drivers.etcd.EtcdDriver` :py:class:`~tooz.drivers.file.FileDriver` :py:class:`~tooz.drivers.ipc.IPCDriver` :py:class:`~tooz.drivers.memcached.MemcachedDriver` :py:class:`~tooz.drivers.mysql.MySQLDriver` :py:class:`~tooz.drivers.pgsql.PostgresDriver` :py:class:`~tooz.drivers.redis.RedisDriver` :py:class:`~tooz.drivers.zake.ZakeDriver` :py:class:`~tooz.drivers.zookeeper.KazooDriver` -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -No No Yes No Yes No No Yes Yes Yes -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= +.. list-table:: + :header-rows: 1 + + * - Driver + - Supported + * - :py:class:`~tooz.drivers.consul.ConsulDriver` + - No + * - :py:class:`~tooz.drivers.etcd.EtcdDriver` + - No + * - :py:class:`~tooz.drivers.file.FileDriver` + - Yes + * - :py:class:`~tooz.drivers.ipc.IPCDriver` + - No + * - :py:class:`~tooz.drivers.memcached.MemcachedDriver` + - Yes + * - :py:class:`~tooz.drivers.mysql.MySQLDriver` + - No + * - :py:class:`~tooz.drivers.pgsql.PostgresDriver` + - No + * - :py:class:`~tooz.drivers.redis.RedisDriver` + - Yes + * - :py:class:`~tooz.drivers.zake.ZakeDriver` + - Yes + * - :py:class:`~tooz.drivers.zookeeper.KazooDriver` + - Yes Leaders ======= @@ -44,11 +64,31 @@ APIs Driver support -------------- -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -:py:class:`~tooz.drivers.consul.ConsulDriver` :py:class:`~tooz.drivers.etcd.EtcdDriver` :py:class:`~tooz.drivers.file.FileDriver` :py:class:`~tooz.drivers.ipc.IPCDriver` :py:class:`~tooz.drivers.memcached.MemcachedDriver` :py:class:`~tooz.drivers.mysql.MySQLDriver` :py:class:`~tooz.drivers.pgsql.PostgresDriver` :py:class:`~tooz.drivers.redis.RedisDriver` :py:class:`~tooz.drivers.zake.ZakeDriver` :py:class:`~tooz.drivers.zookeeper.KazooDriver` -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -No No No No Yes No No Yes Yes Yes -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= +.. list-table:: + :header-rows: 1 + + * - Driver + - Supported + * - :py:class:`~tooz.drivers.consul.ConsulDriver` + - No + * - :py:class:`~tooz.drivers.etcd.EtcdDriver` + - No + * - :py:class:`~tooz.drivers.file.FileDriver` + - No + * - :py:class:`~tooz.drivers.ipc.IPCDriver` + - No + * - :py:class:`~tooz.drivers.memcached.MemcachedDriver` + - Yes + * - :py:class:`~tooz.drivers.mysql.MySQLDriver` + - No + * - :py:class:`~tooz.drivers.pgsql.PostgresDriver` + - No + * - :py:class:`~tooz.drivers.redis.RedisDriver` + - Yes + * - :py:class:`~tooz.drivers.zake.ZakeDriver` + - Yes + * - :py:class:`~tooz.drivers.zookeeper.KazooDriver` + - Yes Locking ======= @@ -61,8 +101,28 @@ APIs Driver support -------------- -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -:py:class:`~tooz.drivers.consul.ConsulDriver` :py:class:`~tooz.drivers.etcd.EtcdDriver` :py:class:`~tooz.drivers.file.FileDriver` :py:class:`~tooz.drivers.ipc.IPCDriver` :py:class:`~tooz.drivers.memcached.MemcachedDriver` :py:class:`~tooz.drivers.mysql.MySQLDriver` :py:class:`~tooz.drivers.pgsql.PostgresDriver` :py:class:`~tooz.drivers.redis.RedisDriver` :py:class:`~tooz.drivers.zake.ZakeDriver` :py:class:`~tooz.drivers.zookeeper.KazooDriver` -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= -Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes -=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= +.. list-table:: + :header-rows: 1 + + * - Driver + - Supported + * - :py:class:`~tooz.drivers.consul.ConsulDriver` + - Yes + * - :py:class:`~tooz.drivers.etcd.EtcdDriver` + - Yes + * - :py:class:`~tooz.drivers.file.FileDriver` + - Yes + * - :py:class:`~tooz.drivers.ipc.IPCDriver` + - Yes + * - :py:class:`~tooz.drivers.memcached.MemcachedDriver` + - Yes + * - :py:class:`~tooz.drivers.mysql.MySQLDriver` + - Yes + * - :py:class:`~tooz.drivers.pgsql.PostgresDriver` + - Yes + * - :py:class:`~tooz.drivers.redis.RedisDriver` + - Yes + * - :py:class:`~tooz.drivers.zake.ZakeDriver` + - Yes + * - :py:class:`~tooz.drivers.zookeeper.KazooDriver` + - Yes @@ -58,11 +58,6 @@ commands = exclude=.venv,.git,.tox,dist,*egg,*.egg-info,build,examples,doc show-source = True -[doc8] - -ignore-path = doc/source/user/compatibility.rst,doc/source/history.rst - - [testenv:releasenotes] deps = .[doc] commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html |