openstack/openstack-ansible
Code Issues Proposed changes

Merge "Document the Release Notes build"

Browse Source
This commit is contained in:
Jenkins 2016-05-13 20:33:48 +00:00 committed by Gerrit Code Review
commit 5645b683ee
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/developer-docs/scripts.rst
View File

@ -166,12 +166,30 @@ Documentation may be built locally by executing:
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
Release Notes Build
-------------------
Release notes are generated using the `the reno tool`_ and compiled into
HTML using Sphinx.
Release notes may be built locally by executing:
.. code-block:: bash
tox -e releasenotes
.. _the reno tool: http://docs.openstack.org/developer/reno/usage.html
Gating Gating
^^^^^^ ^^^^^^
Every commit to OpenStack-Ansible is verified by OpenStack-CI through the Every commit to OpenStack-Ansible is verified by OpenStack-CI through the
following jobs: following jobs:
* ``gate-openstack-ansible-releasenotes``: This job executes the
`Release Notes Build`_.
* ``gate-openstack-ansible-docs``: This job executes the * ``gate-openstack-ansible-docs``: This job executes the
`Documentation Build`_. `Documentation Build`_.