openstack
/
oslo.messaging
Code Issues Proposed changes

Use Sphinx 1.5 warning-is-error 

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

The history document is removed because some of the commit messages used
in ChangeLog were being identified as invalid markup and there doesn't
appear to be anyway to edit there retroactively nor disable warnings on
a specific file.

Change-Id: I79e7ac56d5af1151865686761f3d40a11efbf472
This commit is contained in:
Stephen Finucane 2017-03-16 14:45:05 +00:00
parent 06c993d550
commit 1251c0fef1
3 changed files with 2 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/history.rst
View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

8
doc/source/index.rst
View File

@ -31,14 +31,6 @@ Contents
FAQ
contributing
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================

6
setup.cfg
View File

@ -81,9 +81,10 @@ oslo.config.opts =
oslo.messaging = oslo_messaging.opts:list_opts
[build_sphinx]
warning-is-error = 1
all-files = 1
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html
@ -101,6 +102,3 @@ input_file = oslo_messaging/locale/oslo_messaging.pot
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = oslo_messaging/locale/oslo_messaging.pot
[pbr]
warnerrors = true