openstack/python-novaclient
Code Issues Proposed changes

doc: Start using openstackdoctheme's extlink extension

Browse Source 
This ensures we have version-specific references to other projects [1].

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I3b9db8b71c082dd5f8d0564a9cdfdb2fa6dc5ed6
This commit is contained in:
Takashi NATSUME 2018-10-09 12:06:55 +09:00
parent c7066745b1
commit 0fdb154d9c
4 changed files with 10 additions and 7 deletions
doc/source
cli
nova.rst
conf.py
contributor
testing.rst
reference/api
index.rst

5
doc/source/cli/nova.rst

@ -15,9 +15,8 @@ For help on a specific :command:`nova` command, enter:
of the ``nova`` CLI and into the ``openstack`` CLI. Using
the ``openstack`` client where possible is preferred but
there is not full parity yet for all of the ``nova`` commands.
For information on using the ``openstack`` CLI, see:
https://docs.openstack.org/python-openstackclient/latest/
For information on using the ``openstack`` CLI, see
:python-openstackclient-doc:`OpenStackClient <>`.
.. _nova_command_usage:

5
doc/source/conf.py

@ -79,6 +79,11 @@ html_extra_path = ['_extra']
repository_name = 'openstack/python-novaclient'
bug_project = 'python-novaclient'
bug_tag = ''
openstack_projects = [
'keystoneauth',
'os-client-config',
'python-openstackclient',
]
# -- Options for manual page output ------------------------------------------

2
doc/source/contributor/testing.rst

@ -24,7 +24,7 @@ test targets that can be run to validate the code.
Generate a coverage report on unit testing.
Functional testing assumes the existence of a `clouds.yaml` file as supported
by `os-client-config <https://docs.openstack.org/os-client-config/latest>`__
by :os-client-config-doc:`os-client-config <>`.
It assumes the existence of a cloud named `devstack` that behaves like a normal
DevStack installation with a demo and an admin user/tenant - or clouds named
`functional_admin` and `functional_nonadmin`.

5
doc/source/reference/api/index.rst

@ -53,9 +53,8 @@ application, you can append a (name, version) tuple to the session's
>>> sess = session.Session(auth=auth)
>>> sess.additional_user_agent.append(('shade', '1.2.3'))
For more information on this keystoneauth API, see `Using Sessions`_.
.. _Using Sessions: https://docs.openstack.org/keystoneauth/latest/using-sessions.html
For more information on this keystoneauth API, see
:keystoneauth-doc:`Using Sessions <using-sessions.html>`.
It is also possible to use an instance as a context manager in which case
there will be a session kept alive for the duration of the with statement::