Fix release note links to (now) external docs

Moving the old release notes into the Reno releasenots tree broke
the embedded :doc: roles.  Restore these using sphinx.ext.extlinks to
manage the URL to the OSC docs.

Add the following aliases:
* lpbug - generic Launchpad bug        :lpbug:`123456`
* oscbp - OSC blueprints               :oscbp:`Blue Print <bp-name>`
* oscdoc - OSC Docs                    :oscdoc:`Comamnd List <command-list>`

Change-Id: Iecfdd666d961c35f0ccb3b9f10df1d2620cb099f
This commit is contained in:
Dean Troyer 2016-06-03 16:56:55 -05:00
parent 55a7ba890d
commit 658dc23f26
3 changed files with 33 additions and 14 deletions

View File

@ -40,8 +40,28 @@
extensions = [ extensions = [
'oslosphinx', 'oslosphinx',
'reno.sphinxext', 'reno.sphinxext',
'sphinx.ext.extlinks',
] ]
# Set aliases for extlinks
# * lpbug - generic Launchpad bug :lpbug:`123456`
# * oscbp - OSC blueprints :oscbp:`Blue Print <bp-name>`
# * oscdoc - OSC Docs :oscdoc:`Comamnd List <command-list>`
extlinks = {
'lpbug': (
'https://bugs.launchpad.net/bugs/%s',
'Bug ',
),
'oscbp': (
'https://blueprints.launchpad.net/python-openstackclient/+spec/%s',
'',
),
'oscdoc': (
'http://docs.openstack.org/developer/python-openstackclient/%s.html',
'',
),
}
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

View File

@ -7,4 +7,4 @@ OpenStackClient Release Notes
unreleased unreleased
mitaka mitaka
previous_releases pre_20_releases

View File

@ -1,16 +1,12 @@
================= ================
Previous Releases Pre-2.0 Releases
================= ================
As of release 2.0 the release notes can be found on the OpenStack `Release Notes site`_.
.. _`Release Notes site`: http://docs.openstack.org/releasenotes/python-openstackclient
1.9.0 (17 Nov 2015) 1.9.0 (17 Nov 2015)
=================== ===================
* Several updates to `openstack server` * Several updates to `openstack server`
Blueprint `servers <https://blueprints.launchpad.net/python-openstackclient/+spec/cmd-with-multi-servers>`_ Blueprint :oscbp:`servers <cmd-with-multi-servers>`
* `openstack server start` * `openstack server start`
* `openstack server stop` * `openstack server stop`
@ -364,16 +360,18 @@ As of release 2.0 the release notes can be found on the OpenStack `Release Notes
* Fix ``backup create`` to correctly use the ``--container`` value if supplied. * Fix ``backup create`` to correctly use the ``--container`` value if supplied.
Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_ Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_
* Document the backward-compatibility-breaking changes. * Document the backward-compatibility-breaking changes in
Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_ :oscdoc:`Backwards Incompatible Changes <backwards-incompatible>`.
:lpbug:`1406470`
* Add `--parent`` option to `projct create` command. * Add ``--parent`` option to ``project create`` command
1.1.0 (21 Apr 2015) 1.1.0 (21 Apr 2015)
=================== ===================
* Add global ``--os-cloud`` option to select from a list of cloud configurations. * Add global ``--os-cloud`` option to select from a list of cloud configurations.
See :oscdoc:`Configuration <configuration>` for more details.
* Fix global ``--timing`` option operation. * Fix global ``--timing`` option operation.
Bug `1402577 <https://bugs.launchpad.net/bugs/1402577>`_ Bug `1402577 <https://bugs.launchpad.net/bugs/1402577>`_
@ -461,8 +459,9 @@ As of release 2.0 the release notes can be found on the OpenStack `Release Notes
=================== ===================
* The OpenStackClient content from the OpenStack Wiki has been migrated into * The OpenStackClient content from the OpenStack Wiki has been migrated into
the OSC source repo. This includes the `commands`, `command-list` the OSC source repo. This includes the :oscdoc:`Command Structure <commands>`,
and `humaninterfaceguide` documents. :oscdoc:`Command List <command-list>` and
:oscdoc:`Human Interface Guide <humaninterfaceguide>` documents.
* Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and * Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and
``OS_USER_DOMAIN_NAME`` are not set. This is also done for ``OS_USER_DOMAIN_NAME`` are not set. This is also done for