diff options
| author | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2018-10-09 12:06:55 +0900 |
|---|---|---|
| committer | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2018-10-09 12:22:17 +0900 |
| commit | 0fdb154d9c094a4316c7f216dd6ee957287cd54c (patch) | |
| tree | d1b4903346d4022d3b22de196c490ec7c5828f4d | |
| parent | c7066745b137ad0978d63bb8ba6e520766bc5919 (diff) | |
| download | python-novaclient-0fdb154d9c094a4316c7f216dd6ee957287cd54c.tar.gz | |
doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: I3b9db8b71c082dd5f8d0564a9cdfdb2fa6dc5ed6
| -rw-r--r-- | doc/source/cli/nova.rst | 5 | ||||
| -rw-r--r-- | doc/source/conf.py | 5 | ||||
| -rw-r--r-- | doc/source/contributor/testing.rst | 2 | ||||
| -rw-r--r-- | doc/source/reference/api/index.rst | 5 |
4 files changed, 10 insertions, 7 deletions
diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst index 16d276c6..a8ff713c 100644 --- a/doc/source/cli/nova.rst +++ b/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: diff --git a/doc/source/conf.py b/doc/source/conf.py index 3d4d898e..b98da5d9 100644 --- a/doc/source/conf.py +++ b/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 ------------------------------------------ diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index eeb32634..1b285745 100644 --- a/doc/source/contributor/testing.rst +++ b/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`. diff --git a/doc/source/reference/api/index.rst b/doc/source/reference/api/index.rst index e195abf2..e4d9c4d6 100644 --- a/doc/source/reference/api/index.rst +++ b/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:: |