summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-10-06 18:34:58 +0000
committerGerrit Code Review <review@openstack.org>2018-10-06 18:34:58 +0000
commit36da1a13c0197b3daf02003188cbae93509a644f (patch)
tree01769f6eec66366eb3d05872bfecc1486ed27632
parent7b2177843ba3b84ea95d13bec5a343d1a9106580 (diff)
parentdac6f829af0fcca3586d7e953c7020692ae700c0 (diff)
Merge "docs: Add docs for reno integration"
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/user/features.rst17
2 files changed, 17 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 60cd461..428d835 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -21,6 +21,7 @@ using an install tool such as *pip*.
21* **ChangeLog**: Generate ChangeLog from git log 21* **ChangeLog**: Generate ChangeLog from git log
22* **Manifest**: Generate a sensible manifest from git files and some standard 22* **Manifest**: Generate a sensible manifest from git files and some standard
23 files 23 files
24* **Release Notes**: Generate a release notes file using reno
24* **Requirements**: Store your dependencies in a pip requirements file 25* **Requirements**: Store your dependencies in a pip requirements file
25* **long_description**: Use your README file as a long_description 26* **long_description**: Use your README file as a long_description
26* **Smart find_packages**: Smartly find packages under your root package 27* **Smart find_packages**: Smartly find packages under your root package
diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst
index 7e2e979..106fd1a 100644
--- a/doc/source/user/features.rst
+++ b/doc/source/user/features.rst
@@ -62,7 +62,7 @@ From this, we note a couple of the main features of *pbr*:
62- Extensive use of ``setup.cfg`` for configuration 62- Extensive use of ``setup.cfg`` for configuration
63- Automatic package metadata generation (``version``) 63- Automatic package metadata generation (``version``)
64- Automatic metadata file generation (``AUTHOR``, ``ChangeLog``, 64- Automatic metadata file generation (``AUTHOR``, ``ChangeLog``,
65 ``MANIFEST.in``) 65 ``MANIFEST.in``, ``RELEASENOTES.txt``)
66 66
67In addition, there are other things that you don't see here but which *pbr* 67In addition, there are other things that you don't see here but which *pbr*
68will do for you: 68will do for you:
@@ -257,6 +257,21 @@ test files.
257 257
258__ https://packaging.python.org/tutorials/distributing-packages/#manifest-in 258__ https://packaging.python.org/tutorials/distributing-packages/#manifest-in
259 259
260Release Notes
261~~~~~~~~~~~~~
262
263.. admonition:: Summary
264
265 *pbr* will automatically use *reno* \'s ``build_reno`` setuptools command
266 to generate a release notes file, if reno is available and configured.
267
268If using *reno*, you may wish to include a copy of the release notes in your
269packages. *reno* provides a ``build_reno`` `setuptools command`__ and, if reno
270is present and configured, *pbr* will automatically call this to generate a
271release notes file for inclusion in your package.
272
273__ https://docs.openstack.org/reno/latest/user/setuptools.html
274
260Setup Commands 275Setup Commands
261-------------- 276--------------
262 277