openstack/python-watcherclient
Code Issues Proposed changes

Turn on warning-is-error in sphinx build

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

Change-Id: I6f93e229cfd9bc56208750d1ddfe88404f89ab8e
This commit is contained in:
Yumeng Bao
2017-06-26 20:13:22 +08:00
parent 1e2a13fe1a
commit 984601ecfa
4 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/cli.rst
View File

@@ -1,6 +1,6 @@
============================================== ===============================================
:program:`watcher` Command-Line Interface (CLI) :program:`watcher` Command-Line Interface (CLI)
============================================== ===============================================
.. program:: watcher .. program:: watcher
.. highlight:: bash .. highlight:: bash
@@ -23,9 +23,9 @@ OpenStack infra-optim Service (Watcher).
In order to use the CLI, you must provide your OpenStack username, password, In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use project (historically called tenant), and auth endpoint. You can use
configuration options :option:`--os-username`, :option:`--os-password`, configuration options :option:``--os-username``, :option:``--os-password``,
:option:`--os-tenant-id` (or :option:`--os-tenant-name`), :option:``--os-tenant-id`` (or :option:``--os-tenant-name``),
and :option:`--os-auth-url`, or set the corresponding and :option:``--os-auth-url``, or set the corresponding
environment variables:: environment variables::
$ export OS_USERNAME=user $ export OS_USERNAME=user
@@ -36,14 +36,14 @@ environment variables::
The command-line tool will attempt to reauthenticate using the provided The command-line tool will attempt to reauthenticate using the provided
credentials for every request. You can override this behavior by manually credentials for every request. You can override this behavior by manually
supplying an auth token using :option:`--watcher-url` and supplying an auth token using :option:``--watcher-url`` and
:option:`--os-auth-token`, or by setting the corresponding environment variables:: :option:``--os-auth-token``, or by setting the corresponding environment variables::
$ export WATCHER_URL=http://watcher.example.org:9322/ $ export WATCHER_URL=http://watcher.example.org:9322/
$ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 $ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Since Keystone can return multiple regions in the Service Catalog, you can Since Keystone can return multiple regions in the Service Catalog, you can
specify the one you want with :option:`--os-region-name` or set the following specify the one you want with :option:``--os-region-name`` or set the following
environment variable. (It defaults to the first in the list returned.) environment variable. (It defaults to the first in the list returned.)
:: ::

4
doc/source/contributing.rst
View File

@@ -1,8 +1,8 @@
.. _contributing: .. _contributing:
=================================== ====================================
Contributing to python-watcherclient Contributing to python-watcherclient
=================================== ====================================
If you're interested in contributing to the python-watcherclient project, If you're interested in contributing to the python-watcherclient project,
the following will help get you started. the following will help get you started.

12
doc/source/openstack_cli.rst
View File

@@ -24,9 +24,9 @@ OpenStack infra-optim Service (Watcher), by using our additional plugin
In order to use the CLI, you must provide your OpenStack username, password, In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use project (historically called tenant), and auth endpoint. You can use
configuration options :option:`--os-username`, :option:`--os-password`, configuration options :option:``--os-username``, :option:``--os-password``,
:option:`--os-tenant-id` (or :option:`--os-tenant-name`), :option:``--os-tenant-id`` (or :option:``--os-tenant-name``),
and :option:`--os-auth-url`, or set the corresponding and :option:``--os-auth-url``, or set the corresponding
environment variables:: environment variables::
$ export OS_USERNAME=user $ export OS_USERNAME=user
@@ -37,14 +37,14 @@ environment variables::
The command-line tool will attempt to reauthenticate using the provided The command-line tool will attempt to reauthenticate using the provided
credentials for every request. You can override this behavior by manually credentials for every request. You can override this behavior by manually
supplying an auth token using :option:`--watcher-url` and supplying an auth token using :option:``--watcher-url`` and
:option:`--os-auth-token`, or by setting the corresponding environment variables:: :option:``--os-auth-token``, or by setting the corresponding environment variables::
export WATCHER_URL=http://watcher.example.org:9322/ export WATCHER_URL=http://watcher.example.org:9322/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Since Keystone can return multiple regions in the Service Catalog, you can Since Keystone can return multiple regions in the Service Catalog, you can
specify the one you want with :option:`--os-region-name` or set the following specify the one you want with :option:``--os-region-name`` or set the following
environment variable. (It defaults to the first in the list returned.) environment variable. (It defaults to the first in the list returned.)
:: ::

1
setup.cfg
View File

@@ -109,6 +109,7 @@ autodoc_index_modules = True
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[bdist_wheel] [bdist_wheel]
universal = 1 universal = 1