From 658dc23f26e6313dc56eba373f0406e1eac4efdd Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Fri, 3 Jun 2016 16:56:55 -0500 Subject: [PATCH] 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 ` * oscdoc - OSC Docs :oscdoc:`Comamnd List ` Change-Id: Iecfdd666d961c35f0ccb3b9f10df1d2620cb099f --- releasenotes/source/conf.py | 20 +++++++++++++++ releasenotes/source/index.rst | 2 +- ...vious_releases.rst => pre_20_releases.rst} | 25 +++++++++---------- 3 files changed, 33 insertions(+), 14 deletions(-) rename releasenotes/source/{previous_releases.rst => pre_20_releases.rst} (97%) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 1b6929e228..12ed68df29 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,8 +40,28 @@ extensions = [ 'oslosphinx', 'reno.sphinxext', + 'sphinx.ext.extlinks', ] +# Set aliases for extlinks +# * lpbug - generic Launchpad bug :lpbug:`123456` +# * oscbp - OSC blueprints :oscbp:`Blue Print ` +# * oscdoc - OSC Docs :oscdoc:`Comamnd 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. templates_path = ['_templates'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 396028942a..e0477df08b 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -7,4 +7,4 @@ OpenStackClient Release Notes unreleased mitaka - previous_releases + pre_20_releases diff --git a/releasenotes/source/previous_releases.rst b/releasenotes/source/pre_20_releases.rst similarity index 97% rename from releasenotes/source/previous_releases.rst rename to releasenotes/source/pre_20_releases.rst index 1999d38cfc..a2af7a9a23 100644 --- a/releasenotes/source/previous_releases.rst +++ b/releasenotes/source/pre_20_releases.rst @@ -1,16 +1,12 @@ -================= -Previous 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 +================ +Pre-2.0 Releases +================ 1.9.0 (17 Nov 2015) =================== * Several updates to `openstack server` - Blueprint `servers `_ + Blueprint :oscbp:`servers ` * `openstack server start` * `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. Bug `1446751 `_ -* Document the backward-compatibility-breaking changes. - Bug `1406470 `_ +* Document the backward-compatibility-breaking changes in + :oscdoc:`Backwards Incompatible Changes `. + :lpbug:`1406470` -* Add `--parent`` option to `projct create` command. +* Add ``--parent`` option to ``project create`` command 1.1.0 (21 Apr 2015) =================== * Add global ``--os-cloud`` option to select from a list of cloud configurations. + See :oscdoc:`Configuration ` for more details. * Fix global ``--timing`` option operation. Bug `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 OSC source repo. This includes the `commands`, `command-list` - and `humaninterfaceguide` documents. + the OSC source repo. This includes the :oscdoc:`Command Structure `, + :oscdoc:`Command List ` and + :oscdoc:`Human Interface Guide ` documents. * Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and ``OS_USER_DOMAIN_NAME`` are not set. This is also done for