openstack
/
python-manilaclient
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. Enable this.

Change-Id: I8ea73cff6dc539c9f9db2f550ad8088812467d1b
This commit is contained in:
Stephen Finucane 2017-04-19 10:41:19 +01:00
parent a6a000fe4d
commit e19b787dd4
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/shell.rst
View File

@ -7,10 +7,10 @@ The :program:`manila` shell utility
The :program:`manila` shell utility interacts with the OpenStack Manila API
from the command line. It supports the entirety of the OpenStack Manila API.
You'll need to provide :program:`manila` with your OpenStack username and
API key. You can do this with the :option:`--os-username`, :option:`--os-password`
and :option:`--os-tenant-name` options, but it's easier to just set them as
environment variables by setting two environment variables:
You'll need to provide :program:`manila` with your OpenStack username and API
key. You can do this with the `--os-username`, `--os-password` and
`--os-tenant-name` options, but it's easier to just set them as environment
variables by setting two environment variables:
.. envvar:: OS_USERNAME or MANILA_USERNAME

3
setup.cfg
View File

@ -37,7 +37,8 @@ oslo.config.opts =
[build_sphinx]
builders = html,man
all_files = 1
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build

1
tox.ini
View File

@ -39,6 +39,7 @@ commands =
commands = {posargs}
[testenv:docs]
basepython = python2.7
whitelist_externals = rm
commands =
rm -rf doc/build