Add file to the reno documentation build to show release notes for
stable/2025.1.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2025.1.
Sem-Ver: feature
Change-Id: I2789e8605f5e9bae63382ca9e822bbc3e2241f36
Add file to the reno documentation build to show release notes for
stable/2024.2.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2024.2.
Sem-Ver: feature
Change-Id: I5b2c70118df024dfc9236c7e1fa39554ffccf5e0
This change is entirely automated save for the update of some mocks from
'io.open' to '__builtins__.open').
We are keeping this change separate from addition of the actual hook so
that we can ignore the commit later.
Change-Id: I0a9d8736632084473b57b57b693322447d7be519
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Add file to the reno documentation build to show release notes for
stable/2024.1.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2024.1.
Sem-Ver: feature
Change-Id: I13bb45d30d3dff73ca48ad8a2ed8bdc982b62d86
This was missed in [0]. Also update the mailing list link after it moved
to mailman3.
[0] Iaf93c892d211fd7465395d8830f56c2977a88f8b
Change-Id: I91168713a854be0c4348bab3fa34f4b1a924f451
Add file to the reno documentation build to show release notes for
stable/2023.2.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2023.2.
Sem-Ver: feature
Change-Id: I608edcb863038522677beb8bd2e1eb98c1eec363
On the index page we stopped updating versions table since train. Add
missing entries.
Also small rephrasement in the into on backwards compatibility not to
stick with an ancient release name.
Set oldest release on unreleased page correspondingly.
Change-Id: I4a442708a5b47f573cd2333545531499b9eae0f1
for some reason (clearly another change somewhere in the Sphinx)
extlinks extension used in the releasenotes is failing when extlink
caption is not having substitues same as in the link itself.
> title = caption % part
> ~~~~~~~~^~~~~~
> TypeError: not all arguments converted during string formatting
Now the extension supports setting link capturion to None which works as
we need.
Change-Id: Ie1a61e9b3ee5d727d59525efe34aea696538e2b3
Black used with the '-l 79 -S' flags.
A future change will ignore this commit in git-blame history by adding a
'git-blame-ignore-revs' file.
Change-Id: I356643d06b2cd408ccaedfe02b858aea55388949
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Add file to the reno documentation build to show release notes for
stable/2023.1.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2023.1.
Sem-Ver: feature
Change-Id: I248bcb0342afb8276ba9605963287f620b62b6c5
Add file to the reno documentation build to show release notes for
stable/zed.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/zed.
Sem-Ver: feature
Change-Id: Ie570af5ce752d91190ebf6aa3c5ff2329afa36d3
Add file to the reno documentation build to show release notes for
stable/yoga.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/yoga.
Sem-Ver: feature
Change-Id: Ie1126dddd3666d3dc108190133df5e3b085a8404
With Sphinx==4.4.0 some "helpful" warnings were introduced when an
external link could be replaced by a macro, like for :lpbug:. Sadly we
have a very high number of existing release notes that trigger these
warnings and no good way to fix them retrospectively, because would mess
up their mapping to releases. So we change the logging for the
sphinx.ext.extlinks to ignore these warnings for now.
Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Change-Id: I709de5e454434b8790a68d9e67ca1432387b21ab
Add file to the reno documentation build to show release notes for
stable/xena.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/xena.
Sem-Ver: feature
Change-Id: Iedf2c908bf5a9d87effa02717eb604ee8d15ef3b
Add file to the reno documentation build to show release notes for
stable/wallaby.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/wallaby.
Sem-Ver: feature
Change-Id: I848e21bf2d2ea1a1a132525070e5f20d7ff8478d
Add file to the reno documentation build to show release notes for
stable/victoria.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/victoria.
Change-Id: I6c1a9cdff90f7073082fc057f0f11b184de5dc32
Sem-Ver: feature
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Set openstackdocs_auto_name to use 'project' as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Depends-On: https://review.opendev.org/729744
Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
Add file to the reno documentation build to show release notes for
stable/ussuri.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/ussuri.
Change-Id: Ia0c7a6f2d84a7ed08514a64a73a5de577fcfb1d0
Sem-Ver: feature
Add file to the reno documentation build to show release notes for
stable/train.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/train.
Change-Id: I2cab236b14bc5eac173d815a634c8d8eb2afee04
Sem-Ver: feature
This fixes the docs bug link generation for the normal docs
and release notes docs.
The requirement on openstackdocstheme is bumped to 1.23.2 to
pick up fix I2ed164b9b0badade702c50543ac1a5eea4d1867b.
Change-Id: I89711a391ee0fb7e40c1fbf83f950e2b582358d9
Story: #2005467
Task: #30546
Add file to the reno documentation build to show release notes for
stable/stein.
Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/stein.
Change-Id: I3edfae7c1c5f8268186455efc7add28dc38810fb
Sem-Ver: feature
The table indicating the openstackclient release at the time of the
overall OpenStack release had not been updated since Pike. This adds
release versions for Queens and Rocky.
Change-Id: Icd9a72c2460fae3d1b714b6da473564e6c709ef6
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.
Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.
This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.
Change-Id: Ia0c8d7dc346182fde095eebb82eeeb70fc1b9770
In the release notes build, openstackdocstheme is specified
in the sphinx extension list, but it is actually not used.
This commit configures openstackdocstheme as suggested in
the openstackdocstheme document.
Also specifies display_toc False in html_theme_options.
This prevents openstackdocstheme to add the local TOC automatically.
OSC has several releases during a single development cycle and
it leads to a long TOC at the top of individual pages.
It loses the readability and we can see version numbers in the
left sidebar, so we can safely disable the local TOC in
the release notes.
[1] https://docs.openstack.org/openstackdocstheme/latest/
Change-Id: Iae08d309f7589bb13a1766f6fded70673ba24047
