From f6f814b50495588fe3b9c29b487f6c5428ccffe8 Mon Sep 17 00:00:00 2001 From: zhurong Date: Sat, 24 Jun 2017 09:38:47 +0800 Subject: [PATCH] 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 --- doc/source/index.rst | 8 ++++---- setup.cfg | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index a3a2385b..01ffe8fe 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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/ diff --git a/setup.cfg b/setup.cfg index 895086c2..f92a3d78 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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