summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Stanley <fungi@yuggoth.org>2020-08-04 13:58:44 +0000
committerJeremy Stanley <fungi@yuggoth.org>2020-08-11 21:20:17 +0000
commit175fad9af9fa95b1a49fe1d8759bd71e6a5e456e (patch)
treed5d4c6edb49b29ce2a9742bd2a5ed5eee0b6a6fc
parent5fdbae59525fde5911d4cfe9600c3f3a3e9395a4 (diff)
downloadpbr-175fad9af9fa95b1a49fe1d8759bd71e6a5e456e.tar.gz
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
-rw-r--r--.gitignore2
-rw-r--r--README.rst1
-rw-r--r--doc/source/user/index.rst1
-rw-r--r--doc/source/user/releasenotes.rst6
-rw-r--r--tox.ini2
5 files changed, 11 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index eaebb3e..ac108e4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,8 @@ doc/source/reference/api/
# Files created by releasenotes build
releasenotes/build
+releasenotes/notes/reno.cache
+RELEASENOTES.rst
# Packages/installer info
*.egg
diff --git a/README.rst b/README.rst
index 3b6da88..0b6c229 100644
--- a/README.rst
+++ b/README.rst
@@ -34,6 +34,7 @@ them as quickly as possible.
* Documentation: https://docs.openstack.org/pbr/latest/
* Source: https://opendev.org/openstack/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
.. _d2to1: https://pypi.python.org/pypi/d2to1
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
index 7854dc5..0c5fec2 100644
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@@ -9,4 +9,5 @@
packagers
semver
compatibility
+ releasenotes
history
diff --git a/doc/source/user/releasenotes.rst b/doc/source/user/releasenotes.rst
new file mode 100644
index 0000000..6647c66
--- /dev/null
+++ b/doc/source/user/releasenotes.rst
@@ -0,0 +1,6 @@
+===============
+ Release Notes
+===============
+
+.. include:: ../../../RELEASENOTES.rst
+ :start-line: 4
diff --git a/tox.ini b/tox.ini
index 6bebc70..7bc530a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -26,8 +26,8 @@ deps =
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build doc/source/reference/api
+ python setup.py sdist
sphinx-build -W -b html doc/source doc/build/html {posargs}
-usedevelop = False
[testenv:releasenotes]
whitelist_externals = rm