diff options
| author | Monty Taylor <mordred@inaugust.com> | 2015-12-30 13:10:47 -0600 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2015-12-30 13:35:40 -0600 |
| commit | 594e31a4c262c9ae3fe14e2e4c0fdb71a0df0747 (patch) | |
| tree | 815d526078ef9d809260e694f707dada69381a12 | |
| parent | f8c270113579e655fba519a3592a05d982653780 (diff) | |
| download | os-client-config-594e31a4c262c9ae3fe14e2e4c0fdb71a0df0747.tar.gz | |
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: I8153ec7861b508297a28a1916771776dee2deafe
| -rwxr-xr-x | doc/source/conf.py | 3 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/releasenotes.rst | 5 | ||||
| -rw-r--r-- | releasenotes/notes/started-using-reno-242e2b0cd27f9480.yaml | 3 | ||||
| -rw-r--r-- | test-requirements.txt | 1 |
5 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 221de3c..208517c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'oslosphinx', + 'reno.sphinxext' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/doc/source/index.rst b/doc/source/index.rst index cc5dbf4..bf667b7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,7 @@ contributing installation api-reference + releasenotes Indices and tables ================== diff --git a/doc/source/releasenotes.rst b/doc/source/releasenotes.rst new file mode 100644 index 0000000..2a4bceb --- /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 0000000..d7cfb51 --- /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 7053051..a50a202 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -16,6 +16,7 @@ python-subunit>=0.0.18 sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 oslosphinx>=2.5.0,<2.6.0 # Apache-2.0 oslotest>=1.5.1,<1.6.0 # Apache-2.0 +reno>=0.1.1 # Apache2 testrepository>=0.0.18 testscenarios>=0.4 testtools>=0.9.36,!=1.2.0 |