openstack
/
cookiecutter
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. We should
enable this by default to prevent suprise for users.

Change-Id: Iff674c6b8a2f9d8d898817d1995a08674a8416a4
This commit is contained in:
Stephen Finucane 2017-03-21 15:35:11 +00:00
parent aaac231ddb
commit a1d2380180
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
{{cookiecutter.repo_name}}/setup.cfg
View File

@ -24,9 +24,10 @@ packages =
{{ cookiecutter.module_name }}
[build_sphinx]
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html