Add Release Notes to documentation

We're building the sdist to be able to add PBR's changelog in its
docs, so may as well publish the Release Notes document it builds
too.

Change-Id: Icd1b4ae04de8034bc15db87be457751e70e26f6d
This commit is contained in:
Jeremy Stanley 2020-08-04 13:58:44 +00:00
parent 5fdbae5952
commit 175fad9af9
5 changed files with 11 additions and 1 deletions

2
.gitignore vendored

@ -9,6 +9,8 @@ doc/source/reference/api/
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build
releasenotes/notes/reno.cache
RELEASENOTES.rst
# Packages/installer info # Packages/installer info
*.egg *.egg

@ -34,6 +34,7 @@ them as quickly as possible.
* Documentation: https://docs.openstack.org/pbr/latest/ * Documentation: https://docs.openstack.org/pbr/latest/
* Source: https://opendev.org/openstack/pbr * Source: https://opendev.org/openstack/pbr
* Bugs: https://bugs.launchpad.net/pbr * Bugs: https://bugs.launchpad.net/pbr
* Release Notes: https://docs.openstack.org/pbr/latest/user/releasenotes.html
* ChangeLog: https://docs.openstack.org/pbr/latest/user/history.html * ChangeLog: https://docs.openstack.org/pbr/latest/user/history.html
.. _d2to1: https://pypi.python.org/pypi/d2to1 .. _d2to1: https://pypi.python.org/pypi/d2to1

@ -9,4 +9,5 @@
packagers packagers
semver semver
compatibility compatibility
releasenotes
history history

@ -0,0 +1,6 @@
===============
Release Notes
===============
.. include:: ../../../RELEASENOTES.rst
:start-line: 4

@ -26,8 +26,8 @@ deps =
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt
commands = commands =
rm -rf doc/build doc/source/reference/api rm -rf doc/build doc/source/reference/api
python setup.py sdist
sphinx-build -W -b html doc/source doc/build/html {posargs} sphinx-build -W -b html doc/source doc/build/html {posargs}
usedevelop = False
[testenv:releasenotes] [testenv:releasenotes]
whitelist_externals = rm whitelist_externals = rm