openstack
/
python-muranoclient
Code Issues Proposed changes

Turn on warning-is-error in sphinx build 

Turn on the flag to ensure that future warnings in the doc build
trigger a build failure.

Change-Id: Ic5564ad1ff1b0747f0e45d225c61ac9be4ddce5f
This commit is contained in:
zhurong 2017-06-24 09:38:47 +08:00
parent 39aea7fc21
commit f6f814b504
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/index.rst
View File

@ -31,8 +31,8 @@ Command-line Tool
In order to use the CLI, you must provide your OpenStack username,
password, tenant, and auth endpoint. Use the corresponding configuration
options (:option:`--os-username`, :option:`--os-password`,
:option:`--os-tenant-id`, and :option:`--os-auth-url`) or
options (:option:``--os-username``, :option:``--os-password``,
:option:``--os-tenant-id``, and :option:``--os-auth-url``) or
set them in environment variables::
export OS_USERNAME=user
@ -42,8 +42,8 @@ set them in environment variables::
The command line tool will attempt to reauthenticate using your provided
credentials for every request. You can override this behavior by manually
supplying an auth token using :option:`--os-image-url` and
:option:`--os-auth-token`. You can alternatively set these environment
supplying an auth token using :option:``--os-image-url`` and
:option:``--os-auth-token``. You can alternatively set these environment
variables::
export MURANO_URL=http://murano.example.org:8082/

1
setup.cfg
View File

@ -73,6 +73,7 @@ tag_svn_revision = 0
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html