openstack
/
reno
Code Issues Proposed changes

Update to Sphinx 1.5, tread warnings as errors 

Update to newer sphinx, handle warnings in doc building as errors with
setting warning-is-error.

Allow non-local image paths to import the badge.

Change-Id: I57ee9972dbab2cdcf2ef6589cbcd1bc12fbcacb8
This commit is contained in:
Andreas Jaeger 2017-03-03 19:47:57 +01:00
parent 3387cfb3a6
commit 6d67626e2b
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/conf.py
View File

@ -51,6 +51,9 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# Do not warn about non-local image URI
suppress_warnings = ['image.nonlocal_uri']
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with

5
setup.cfg
View File

@ -29,13 +29,14 @@ console_scripts =
[extras]
sphinx =
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
sphinx>=1.5.1 # BSD
docutils>=0.11 # OSI-Approved Open Source, Public Domain
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html