From 1c466668e179829544193c8c711661ca28901ae6 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 20 Apr 2018 14:47:16 -0400 Subject: [PATCH] Fail Sphinx build even on warnings Resolve warnings caused by the -W flag. Change-Id: I0c771da88af487e3a6ddb55b01d524d5a274226d Signed-off-by: Thanh Ha --- docs/configuration.rst | 4 ++-- docs/index.rst | 15 +++++++++------ docs/jjb/lf-macros.rst | 2 +- tox.ini | 2 +- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index e1177e1a..e212d9ce 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -19,7 +19,7 @@ Documentation for npmrc is available via the `npm project `_. :Required: This file MUST exist. An empty file is acceptable if a -proxy is not available for the project. + proxy is not available for the project. :type: Custom file Create a "Custom file" with contents: @@ -36,7 +36,7 @@ in $HOME/.config/pip/pip.conf. Documentation for pip.conf is available via the `pip project `_. :Required: This file MUST exist. An empty file is acceptable if a -proxy is not available for the project. + proxy is not available for the project. :type: Custom file Create a "Custom file" with contents: diff --git a/docs/index.rst b/docs/index.rst index 78931120..0eec76f5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,12 +35,15 @@ Global JJB Templates Job template code is in the `jjb/` directory but documentation is in the `docs/jjb/` directory of this project. -- :doc:`jjb/lf-ci-jobs` -- :doc:`jjb/lf-macros` -- :doc:`jjb/lf-maven-jobs` -- :doc:`jjb/lf-node-jobs` -- :doc:`jjb/lf-python-jobs` -- :doc:`jjb/lf-rtd-jobs` +.. toctree:: + :maxdepth: 1 + + jjb/lf-ci-jobs + jjb/lf-macros + jjb/lf-maven-jobs + jjb/lf-node-jobs + jjb/lf-python-jobs + jjb/lf-rtd-jobs Indices and tables ================== diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index a5da00d3..72d898c6 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -118,7 +118,7 @@ Call pip install to install packages into a virtualenv located in .. note:: The first package listed in PIP_PACKAGES is used as the VENV name. -.. _lf-provide-maven-settings +.. _lf-provide-maven-settings: lf-provide-maven-settings ------------------------- diff --git a/tox.ini b/tox.ini index 0a3413b5..4d0f0f92 100644 --- a/tox.ini +++ b/tox.ini @@ -19,7 +19,7 @@ commands = [testenv:docs] deps = -rrequirements.txt commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo -- 2.16.6