From cf124578960f2420157953bfa86761524537e32f Mon Sep 17 00:00:00 2001
From: Akihiro Motoki <amotoki@gmail.com>
Date: Thu, 6 Jul 2017 23:43:55 +0000
Subject: [PATCH] Turn on warning-is-error in doc build

- Update sphinx so that warning-is-error option is available
- Fix sphinx warnings
- Install python modules required for automodule into docs env
- Fix docstring warning in tooz/coordination.py
- pbr warnerrors is no longer needed in favor of sphinx warning-is-error

Change-Id: I5d54c452522b6ee00884d7d17105af22b4c95189
---
 doc/source/conf.py            | 2 +-
 doc/source/tutorial/index.rst | 1 +
 setup.cfg                     | 6 ++----
 tooz/coordination.py          | 2 +-
 tox.ini                       | 4 ++--
 5 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 9efb5c91..3cf4fb20 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -131,7 +131,7 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
diff --git a/doc/source/tutorial/index.rst b/doc/source/tutorial/index.rst
index eeb2ea01..c2d398c4 100644
--- a/doc/source/tutorial/index.rst
+++ b/doc/source/tutorial/index.rst
@@ -13,3 +13,4 @@ use tooz in your application.
    leader_election
    lock
    hashring
+   partitioner
diff --git a/setup.cfg b/setup.cfg
index 5abaa57c..eddd37a9 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -72,13 +72,10 @@ test =
   pifpaf>=0.10.0 # Apache-2.0
   os-testr>=0.8.0 # Apache-2.0
 doc =
-  sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
+  sphinx>=1.6.2 # BSD
   oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
   reno>=1.8.0 # Apache-2.0
 
-[pbr]
-warnerrors = True
-
 [wheel]
 universal = 1
 
@@ -86,3 +83,4 @@ universal = 1
 all_files = 1
 build-dir = doc/build
 source-dir = doc/source
+warning-is-error = 1
diff --git a/tooz/coordination.py b/tooz/coordination.py
index e573ed10..f1187925 100755
--- a/tooz/coordination.py
+++ b/tooz/coordination.py
@@ -59,7 +59,7 @@ class Characteristics(enum.Enum):
     """The driver has the following property:
 
     * Its operations are not based on the timeout of other clients, but on some
-    other more robust mechanisms.
+      other more robust mechanisms.
     """
 
     LINEARIZABLE = 'LINEARIZABLE'
diff --git a/tox.ini b/tox.ini
index cb6d2957..2f5bcf28 100644
--- a/tox.ini
+++ b/tox.ini
@@ -37,14 +37,14 @@ commands =
 
 [testenv:venv]
 # This target is used by the gate go run Sphinx to build the doc
-deps = .[doc]
+deps = {[testenv:docs]deps}
 commands = {posargs}
 
 [testenv:cover]
 commands = python setup.py testr --slowest --coverage --testr-args="{posargs}"
 
 [testenv:docs]
-deps = .[doc]
+deps = .[doc,zake,ipc,zookeeper,redis,memcached,mysql,postgresql,consul]
 commands = python setup.py build_sphinx
 
 [testenv:pep8]