diff options
author | Zuul <zuul@review.openstack.org> | 2018-10-16 16:08:13 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2018-10-16 16:08:13 +0000 |
commit | bd300d07ee016bf04b5da783fa696754b8a49af8 (patch) | |
tree | 50ca069275418e4a6367d5bd0599b1f849356ad9 /doc | |
parent | 73a763d1e3cb2f00c2dc4fbfecfab487f9698818 (diff) | |
parent | a34629a956e614f60932e664801393cf1200438d (diff) | |
download | pbr-bd300d07ee016bf04b5da783fa696754b8a49af8.tar.gz |
Merge "Add an option to skip generating RELEASENOTES.rst"5.1.0
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/user/packagers.rst | 17 | ||||
-rw-r--r-- | doc/source/user/using.rst | 8 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/source/user/packagers.rst b/doc/source/user/packagers.rst index 74af8ac..2e705b0 100644 --- a/doc/source/user/packagers.rst +++ b/doc/source/user/packagers.rst @@ -103,3 +103,20 @@ skipped. Similarly setting ``SKIP_WRITE_GIT_CHANGELOG`` will cause logic around generating ``ChangeLog`` file using *git* information to be skipped. + +.. _packaging-releasenotes: + +Release Notes +------------- + +*pbr* generates a release notes file, typically called ``RELEASENOTES.rst``, +if `reno`_ is present and configured. You may wish to disable this +functionality. If that is the case setting ``SKIP_GENERATE_RENO`` + +:: + + export SKIP_GENERATE_RENO + +will disable this feature. + +.. _reno: https://docs.openstack.org/reno/latest/ diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst index 0104640..2e58fee 100644 --- a/doc/source/user/using.rst +++ b/doc/source/user/using.rst @@ -230,6 +230,13 @@ The ``pbr`` section controls *pbr*-specific options and behaviours. This can also be configured using the ``SKIP_GENERATE_AUTHORS`` environment variable, as described :ref:`here <packaging-authors-changelog>` +``skip_reno`` + If enabled, *pbr* will not generate a ``RELEASENOTES.txt`` file if `reno`_ is + present and configured. + + This can also be configured using the ``SKIP_GENERATE_RENO`` environment + variable, as described :ref:`here <packaging-releasenotes>`. + ``autodoc_tree_index_modules`` A boolean option controlling whether *pbr* should generate an index of modules using ``sphinx-apidoc``. By default, all files except ``setup.py`` @@ -487,3 +494,4 @@ this file. .. _setuptools: http://www.sphinx-doc.org/en/stable/setuptools.html .. _sphinxcontrib-apidoc: https://pypi.org/project/sphinxcontrib-apidoc/ +.. _reno: https://docs.openstack.org/reno/latest/ |