openstack/tooz
Code Issues Proposed changes

doc: use list-table for driver support tables

Browse Source 
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
This commit is contained in:
Akihiro Motoki 2017-07-07 03:21:54 +00:00
parent 2ca15fedbe
commit ee6f82d9d5
2 changed files with 75 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
doc/source/user/compatibility.rst
View File

@ -24,11 +24,31 @@ APIs
Driver support Driver support
-------------- --------------
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= .. list-table::
: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` :header-rows: 1
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== =================================================
No No Yes No Yes No No Yes Yes Yes * - 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 Leaders
======= =======
@ -44,11 +64,31 @@ APIs
Driver support Driver support
-------------- --------------
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= .. list-table::
: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` :header-rows: 1
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== =================================================
No No No No Yes No No Yes Yes Yes * - 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 Locking
======= =======
@ -61,8 +101,28 @@ APIs
Driver support Driver support
-------------- --------------
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== ================================================= .. list-table::
: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` :header-rows: 1
=============================================== =========================================== =========================================== ========================================= ===================================================== ============================================= ================================================ ============================================= =========================================== =================================================
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes * - 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

5
tox.ini
View File

@ -58,11 +58,6 @@ commands =
exclude=.venv,.git,.tox,dist,*egg,*.egg-info,build,examples,doc exclude=.venv,.git,.tox,dist,*egg,*.egg-info,build,examples,doc
show-source = True show-source = True
[doc8]
ignore-path = doc/source/user/compatibility.rst,doc/source/history.rst
[testenv:releasenotes] [testenv:releasenotes]
deps = .[doc] deps = .[doc]
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html