From 1f0425abc8150cea3fbbe693ac5c785da12da5f4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 28 Aug 2018 13:10:08 +0200 Subject: [PATCH] Add -W to sphinx-build invocation With the new PTI interface, we build using tox -e docs. By default, we should tread warnings as errors. Add -W to sphinx-build everywhere where it's missing, some places had it already, especially reference/project-testing-interface.rst. Change-Id: Iec6f93fd45bc26d044197112c826cbaf83daca66 --- reference/pti/golang.rst | 2 +- reference/pti/python.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/pti/golang.rst b/reference/pti/golang.rst index 0d592febb..de341ef16 100644 --- a/reference/pti/golang.rst +++ b/reference/pti/golang.rst @@ -211,7 +211,7 @@ that should: * Either install any needed distro dependencies from the ``doc`` tag in ``bindep.txt`` or emit an error if they are not installed. * Install Python dependencies for Sphinx from ``doc/requirements.txt``. -* Execute ``sphinx-build -b html doc/source doc/build`` +* Execute ``sphinx-build -W -b html doc/source doc/build`` Source ~~~~~~ diff --git a/reference/pti/python.rst b/reference/pti/python.rst index 47fb6e038..0ea75f29f 100644 --- a/reference/pti/python.rst +++ b/reference/pti/python.rst @@ -28,7 +28,7 @@ tree: - tox -ecover - python setup.py sdist - python setup.py bdist_wheel - - sphinx-build -b html doc/source doc/build + - sphinx-build -W -b html doc/source doc/build Projects that are translated should also support: