From d06f2a6728e002f3a199cdef570f92b44da0d45f Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Fri, 16 Nov 2012 17:40:58 +0100 Subject: [PATCH] sphinx is now stricter The documentation files often have minor typo or badly formatted commands which makes sphinx emits a warning. To make sure we always catch them via the Jenkins build, this patch makes sphinx to convert warning to errors thus aborting the build, simply add to pass the -W option to sphinx-build. This patch also fix some warnings: * There is no source/_static dir so disable html_static_path * In launchers.rst, File reference name should be before the title Test plan: $ make clean; make html rm -rf build/* sphinx-build -b html -d build/doctrees -W source build/html Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created loading intersphinx inventory from http://docs.python.org/2.7/objects.inv... building [html]: targets for 5 source files that are out of date updating environment: 5 added, 0 changed, 0 removed reading sources... [100%] zuul looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] zuul writing additional files... genindex search copying static files... done dumping search index... done dumping object inventory... done build succeeded. Build finished. The HTML pages are in build/html. $ Change-Id: Id907cc2c9aeccd077593b2fa1b78b220a159ed71 Reviewed-on: https://review.openstack.org/16316 Reviewed-by: Paul Belanger Reviewed-by: Monty Taylor Reviewed-by: Jeremy Stanley Reviewed-by: James E. Blair Approved: Clark Boylan Reviewed-by: Clark Boylan Tested-by: Jenkins --- doc/Makefile | 2 +- doc/source/conf.py | 2 +- doc/source/launchers.rst | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index 5014008d0b..595766011f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build diff --git a/doc/source/conf.py b/doc/source/conf.py index 43a50d6e51..f357e29bb7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -123,7 +123,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/launchers.rst b/doc/source/launchers.rst index b27882f2dc..0df068d207 100644 --- a/doc/source/launchers.rst +++ b/doc/source/launchers.rst @@ -1,6 +1,8 @@ -.. _launchers: :title: Launchers +.. _launchers: + + Launchers =========