summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2016-06-03 16:56:55 -0500
committerDean Troyer <dtroyer@gmail.com>2016-06-06 10:21:47 -0500
commit658dc23f26e6313dc56eba373f0406e1eac4efdd (patch)
tree4fd30461261d24621c33aff94ff6f90e50e60338
parent55a7ba890d9c3a53b7728efe41053b79ba1e60d3 (diff)
downloadpython-openstackclient-658dc23f26e6313dc56eba373f0406e1eac4efdd.tar.gz
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
-rw-r--r--releasenotes/source/conf.py20
-rw-r--r--releasenotes/source/index.rst2
-rw-r--r--releasenotes/source/pre_20_releases.rst (renamed from releasenotes/source/previous_releases.rst)25
3 files changed, 33 insertions, 14 deletions
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 1b6929e2..12ed68df 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 <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.
templates_path = ['_templates']
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 39602894..e0477df0 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
index 1999d38c..a2af7a9a 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 <https://blueprints.launchpad.net/python-openstackclient/+spec/cmd-with-multi-servers>`_
+ Blueprint :oscbp:`servers <cmd-with-multi-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 <https://bugs.launchpad.net/bugs/1446751>`_
-* Document the backward-compatibility-breaking changes.
- Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_
+* Document the backward-compatibility-breaking changes in
+ :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)
===================
* 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.
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 OSC source repo. This includes the `commands`, `command-list`
- and `humaninterfaceguide` documents.
+ the OSC source repo. This includes the :oscdoc:`Command Structure <commands>`,
+ :oscdoc:`Command List <command-list>` and
+ :oscdoc:`Human Interface Guide <humaninterfaceguide>` 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