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
This commit is contained in:
Akihiro Motoki 2017-07-06 23:43:55 +00:00
parent f947d1f377
commit cf12457896
5 changed files with 7 additions and 8 deletions

View File

@ -131,7 +131,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.

View File

@ -13,3 +13,4 @@ use tooz in your application.
leader_election leader_election
lock lock
hashring hashring
partitioner

View File

@ -72,13 +72,10 @@ test =
pifpaf>=0.10.0 # Apache-2.0 pifpaf>=0.10.0 # Apache-2.0
os-testr>=0.8.0 # Apache-2.0 os-testr>=0.8.0 # Apache-2.0
doc = 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 oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0
[pbr]
warnerrors = True
[wheel] [wheel]
universal = 1 universal = 1
@ -86,3 +83,4 @@ universal = 1
all_files = 1 all_files = 1
build-dir = doc/build build-dir = doc/build
source-dir = doc/source source-dir = doc/source
warning-is-error = 1

View File

@ -37,14 +37,14 @@ commands =
[testenv:venv] [testenv:venv]
# This target is used by the gate go run Sphinx to build the doc # This target is used by the gate go run Sphinx to build the doc
deps = .[doc] deps = {[testenv:docs]deps}
commands = {posargs} commands = {posargs}
[testenv:cover] [testenv:cover]
commands = python setup.py testr --slowest --coverage --testr-args="{posargs}" commands = python setup.py testr --slowest --coverage --testr-args="{posargs}"
[testenv:docs] [testenv:docs]
deps = .[doc] deps = .[doc,zake,ipc,zookeeper,redis,memcached,mysql,postgresql,consul]
commands = python setup.py build_sphinx commands = python setup.py build_sphinx
[testenv:pep8] [testenv:pep8]