Browse Source

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
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-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
Antoine Musso 9 years ago
committed by Jenkins
3 changed files with 5 additions and 3 deletions
  1. +1
  2. +1
  3. +3

+ 1
- 1
doc/Makefile View File

@ -2,7 +2,7 @@
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
BUILDDIR = build

+ 1
- 1
doc/source/ View File

@ -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.

+ 3
- 1
doc/source/launchers.rst View File

@ -1,6 +1,8 @@
.. _launchers:
:title: Launchers
.. _launchers: