From da0a33a85a49d421df269bf502963e34ecb0ba03 Mon Sep 17 00:00:00 2001 From: Joe Gordon Date: Wed, 2 Apr 2014 16:21:37 -0700 Subject: [PATCH] Add specific doc build option and gate on warnings Add doc venv to align with other OpenStack projejcts (such as keystone, heat and nova-specs) who are using 'docs' for there doc builds. Also enable warnerrors in pbr to raise an error if there are any docs formatting warnings. Change-Id: Ifa31edf3c3392106a8aa1352bdd557bde2f1b9a1 --- doc/source/conf.py | 2 +- setup.cfg | 3 +++ tox.ini | 3 +++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e93aa56b0..5730feea5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -156,7 +156,7 @@ modindex_common_prefix = ['marconi.'] # 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 = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/setup.cfg b/setup.cfg index 4108dbe2c..7a1c8c5f9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -87,3 +87,6 @@ cover-inclusive = true ; ; detailed-errors = 1 + +[pbr] +warnerrors = True diff --git a/tox.ini b/tox.ini index 9281761f7..9109c6f1d 100644 --- a/tox.ini +++ b/tox.ini @@ -46,6 +46,9 @@ commands = [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] exclude = .venv*,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*.egg,.update-venv