From 83159ae486aa8a526655d68ef36b16d033de9089 Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Fri, 4 Dec 2015 11:43:07 -0500 Subject: [PATCH] Use reno for release notes The OpenStack Release team has created a great release notes management tool that integrates with Sphinx. Start using it. For reference on how to use it, see http://docs.openstack.org/developer/reno/ Change-Id: I57692d720174fedb68ab2f52d5a4c496a6d993b2 --- doc/source/conf.py | 6 +++++- doc/source/index.rst | 1 + doc/source/installation.rst | 2 +- doc/source/releasenotes.rst | 5 +++++ releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml | 3 +++ test-requirements.txt | 1 + 6 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 doc/source/releasenotes.rst create mode 100644 releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml diff --git a/doc/source/conf.py b/doc/source/conf.py index bbebf4729..e55e85b19 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -3,7 +3,11 @@ import sys sys.path.insert(0, os.path.abspath('../..')) -extensions = ['sphinx.ext.autodoc', 'oslosphinx'] +extensions = [ + 'sphinx.ext.autodoc', + 'oslosphinx', + 'reno.sphinxext' +] # The suffix of source filenames. source_suffix = '.rst' diff --git a/doc/source/index.rst b/doc/source/index.rst index af9eaa3d2..2aa8bd35e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,7 @@ Contents: contributing coding future + releasenotes .. include:: ../../README.rst diff --git a/doc/source/installation.rst b/doc/source/installation.rst index c47e48758..9699e779e 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -9,4 +9,4 @@ At the command line:: Or, if you have virtualenv wrapper installed:: $ mkvirtualenv shade - $ pip install shade \ No newline at end of file + $ pip install shade diff --git a/doc/source/releasenotes.rst b/doc/source/releasenotes.rst new file mode 100644 index 000000000..2a4bceb4e --- /dev/null +++ b/doc/source/releasenotes.rst @@ -0,0 +1,5 @@ +============= +Release Notes +============= + +.. release-notes:: diff --git a/releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml b/releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml new file mode 100644 index 000000000..d7cfb5145 --- /dev/null +++ b/releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml @@ -0,0 +1,3 @@ +--- +other: +- Started using reno for release notes. diff --git a/test-requirements.txt b/test-requirements.txt index d42d7d7f3..d3b6fb988 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,3 +11,4 @@ testrepository>=0.0.17 testscenarios>=0.4,<0.5 testtools>=0.9.32 warlock>=1.0.1,<2 +reno