openstack
/
governance
Code Issues Proposed changes

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
This commit is contained in:
Andreas Jaeger 2018-08-28 13:10:08 +02:00
parent 5036ff5120
commit 1f0425abc8
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reference/pti/golang.rst
View File

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

2
reference/pti/python.rst
View File

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