Skip to content

Commit 1244d4d

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Fix release note links to (now) external docs"
2 parents 19c54b6 + 658dc23 commit 1244d4d

3 files changed

Lines changed: 33 additions & 14 deletions

File tree

releasenotes/source/conf.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,28 @@
4040
extensions = [
4141
'oslosphinx',
4242
'reno.sphinxext',
43+
'sphinx.ext.extlinks',
4344
]
4445

46+
# Set aliases for extlinks
47+
# * lpbug - generic Launchpad bug :lpbug:`123456`
48+
# * oscbp - OSC blueprints :oscbp:`Blue Print <bp-name>`
49+
# * oscdoc - OSC Docs :oscdoc:`Comamnd List <command-list>`
50+
extlinks = {
51+
'lpbug': (
52+
'https://bugs.launchpad.net/bugs/%s',
53+
'Bug ',
54+
),
55+
'oscbp': (
56+
'https://blueprints.launchpad.net/python-openstackclient/+spec/%s',
57+
'',
58+
),
59+
'oscdoc': (
60+
'http://docs.openstack.org/developer/python-openstackclient/%s.html',
61+
'',
62+
),
63+
}
64+
4565
# Add any paths that contain templates here, relative to this directory.
4666
templates_path = ['_templates']
4767

releasenotes/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ OpenStackClient Release Notes
77

88
unreleased
99
mitaka
10-
previous_releases
10+
pre_20_releases
Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
=================
2-
Previous Releases
3-
=================
4-
5-
As of release 2.0 the release notes can be found on the OpenStack `Release Notes site`_.
6-
7-
.. _`Release Notes site`: http://docs.openstack.org/releasenotes/python-openstackclient
1+
================
2+
Pre-2.0 Releases
3+
================
84

95
1.9.0 (17 Nov 2015)
106
===================
117

128
* Several updates to `openstack server`
13-
Blueprint `servers <https://blueprints.launchpad.net/python-openstackclient/+spec/cmd-with-multi-servers>`_
9+
Blueprint :oscbp:`servers <cmd-with-multi-servers>`
1410

1511
* `openstack server start`
1612
* `openstack server stop`
@@ -364,16 +360,18 @@ As of release 2.0 the release notes can be found on the OpenStack `Release Notes
364360
* Fix ``backup create`` to correctly use the ``--container`` value if supplied.
365361
Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_
366362

367-
* Document the backward-compatibility-breaking changes.
368-
Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_
363+
* Document the backward-compatibility-breaking changes in
364+
:oscdoc:`Backwards Incompatible Changes <backwards-incompatible>`.
365+
:lpbug:`1406470`
369366

370-
* Add `--parent`` option to `projct create` command.
367+
* Add ``--parent`` option to ``project create`` command
371368

372369

373370
1.1.0 (21 Apr 2015)
374371
===================
375372

376373
* Add global ``--os-cloud`` option to select from a list of cloud configurations.
374+
See :oscdoc:`Configuration <configuration>` for more details.
377375

378376
* Fix global ``--timing`` option operation.
379377
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
461459
===================
462460

463461
* The OpenStackClient content from the OpenStack Wiki has been migrated into
464-
the OSC source repo. This includes the `commands`, `command-list`
465-
and `humaninterfaceguide` documents.
462+
the OSC source repo. This includes the :oscdoc:`Command Structure <commands>`,
463+
:oscdoc:`Command List <command-list>` and
464+
:oscdoc:`Human Interface Guide <humaninterfaceguide>` documents.
466465

467466
* Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and
468467
``OS_USER_DOMAIN_NAME`` are not set. This is also done for

0 commit comments

Comments
 (0)