[openstack-dev] [reno] using 'releasenotes' directive in documents for released tarball (without git info)
amotoki at gmail.com
Thu Dec 3 16:03:40 UTC 2015
python-neutronclient recently added reno support and
I added the reno directive " . release-notes::" to the neutronclient
As a result, this prevents users from building the documentation from
using 'python setup.py build_sphinx' because the reno module expects a
git tree .
What is the recommended way now?
The easiest way we can do now seems not to include our release notes
(release-notes directive) in our documentation and instead point the
url http://docs.openstack.org/releasenotes/<project> instead.
Of course, reno (or other tool chains) can be improved to generate release notes
during "python setup.py sdist" or similar process so that the
contains 'releasenotes' sphinx directive can be generated even out of git tree.
More information about the OpenStack-dev