openstack/python-aodhclient
Code Issues Proposed changes

fix warnings in documentation build

Browse Source 
Replace the :option: role markup with simpler literal text markup so
that options that are not defined anywhere in the documentation do not
produce warnings.

Turn on the -W option in the docs environment in tox so that local
developer builds of the documentation fail if there is a warning.

Change-Id: I4a97b1efbfddc6137668c23461a882fa589d4999
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-06-13 15:30:49 -04:00
parent 6002b08818
commit 4e8a452e45
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/shell.rst
View File

@ -8,8 +8,8 @@ The :program:`aodh` shell utility interacts with Aodh API
from the command line. It supports the entirety of the Aodh API.
You'll need to provide :program:`aodh` with your OpenStack credentials.
You can do this with the :option:`--os-username`, :option:`--os-password`,
:option:`--os-tenant-id` and :option:`--os-auth-url` options, but it's easier to
You can do this with the ``--os-username``, ``--os-password``,
``--os-tenant-id`` and ``--os-auth-url`` options, but it's easier to
just set them as environment variables:
.. envvar:: OS_USERNAME
@ -37,7 +37,7 @@ For example, in Bash you would use::
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:`--aodh-endpoint` and :option:`--os-auth-token`. You can alternatively
token using ``--aodh-endpoint`` and ``--os-auth-token``. You can alternatively
set these environment variables::
export AODH_ENDPOINT=http://aodh.example.org:8041
@ -45,8 +45,8 @@ set these environment variables::
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Also, if the server doesn't support authentication, you can provide
:option:`--os-auth-plugon` aodh-noauth, :option:`--aodh-endpoint`, :option:`--user-id`
and :option:`--project-id`. You can alternatively set these environment variables::
``--os-auth-plugin`` aodh-noauth, ``--aodh-endpoint``, ``--user-id``
and ``--project-id``. You can alternatively set these environment variables::
export OS_AUTH_PLUGIN=aodh-noauth
export AODH_ENDPOINT=http://aodh.example.org:8041

2
tox.ini
View File

@ -39,7 +39,7 @@ commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasen
deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build
sphinx-build -b html doc/source doc/build/html
sphinx-build -W -b html doc/source doc/build/html
whitelist_externals = rm
[testenv:debug]