diff --git a/doc/source/conf.py b/doc/source/conf.py index c5a97436da6c..cd298a1c5b24 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -134,10 +134,8 @@ latex_documents = [ # keep this ordered to keep mriedem happy # -# NOTE(kchamart): Versioned TripleO Docs is not a yet a "thing". Remove -# this note when they can be versioned, and add 'tripleo-docs' to the -# set of projects below. - +# NOTE(stephenfin): Projects that don't have a release branch, like TripleO and +# reno, should not be included here openstack_projects = [ 'ceilometer', 'cinder', @@ -154,7 +152,6 @@ openstack_projects = [ 'placement', 'python-novaclient', 'python-openstackclient', - 'reno', 'watcher', ] # -- Custom extensions -------------------------------------------------------- diff --git a/doc/source/contributor/releasenotes.rst b/doc/source/contributor/releasenotes.rst index 996889f43ea2..182defd1d5e5 100644 --- a/doc/source/contributor/releasenotes.rst +++ b/doc/source/contributor/releasenotes.rst @@ -6,9 +6,10 @@ Release Notes What is reno ? -------------- -Nova uses :reno-doc:`reno <>` for providing release notes in-tree. That means -that a patch can include a *reno file* or a series can have a follow-on change -containing that file explaining what the impact is. +Nova uses `reno `__ for providing +release notes in-tree. That means that a patch can include a *reno file* or a +series can have a follow-on change containing that file explaining what the +impact is. A *reno file* is a YAML file written in the ``releasenotes/notes`` tree which is generated using the *reno* tool this way: @@ -20,7 +21,9 @@ is generated using the *reno* tool this way: where usually ```` can be ``bp-`` for a blueprint or ``bug-XXXXXX`` for a bugfix. -Refer to the :reno-doc:`reno documentation ` for more information. +Refer to the `reno documentation +`__ for more +information. When a release note is needed