hiro/releases
1
0
Fork 0
mirror of https://github.com/vale981/releases synced 2025-03-05 17:51:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Changelog, doc updates re #41

Browse source
This commit is contained in:
Jeff Forcier 2015-11-05 11:32:35 -08:00
parent 996b26cf05
commit 17dbe96f13
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/changelog.rst
View file

@ -2,6 +2,11 @@
Changelog Changelog
========= =========
* :feature:`41` Update changelog discovery to use a docutils ``NodeVisitor``
instead of naively assuming the 2nd child node of the document is always the
bulleted list we expect it to be. This allows one to have comments,
paragraphs or other non-bullet-list elements above or below the changelog.
Thanks to Rodrigue Cloutier for the original patch.
* :release:`0.7.0 <2014-09-04>` * :release:`0.7.0 <2014-09-04>`
* :bug:`30 major` Add LICENSE (plus a handful of other administrative files) to * :bug:`30 major` Add LICENSE (plus a handful of other administrative files) to
a ``MANIFEST.in`` so sdists pick it up. Thanks to Zygmunt Krynicki for catch a ``MANIFEST.in`` so sdists pick it up. Thanks to Zygmunt Krynicki for catch

7
docs/usage.rst
View file

@ -32,13 +32,16 @@ Specifically:
* You may optionally set ``releases_debug = True`` to see debug output * You may optionally set ``releases_debug = True`` to see debug output
while building your docs. while building your docs.
* Create a Sphinx document named ``changelog.rst`` with a top-level header * Create a Sphinx document named ``changelog.rst`` containing a bulleted list
followed by a bulleted list. somewhere at its topmost level.
* If you wish to use a different document name, use another config option * If you wish to use a different document name, use another config option
(as per previous bullet point), ``releases_document_name``. E.g. (as per previous bullet point), ``releases_document_name``. E.g.
``releases_document_name = "CHANGES"`` would cause Releases to mutate a ``releases_document_name = "CHANGES"`` would cause Releases to mutate a
file called ``CHANGES.rst`` instead of ``changelog.rst``. file called ``CHANGES.rst`` instead of ``changelog.rst``.
* Elements before or after this bulleted list will be untouched by
Releases, allowing you to place e.g. paragraphs, comments etc at the top
(or bottom) of the document.
* List items are to be ordered chronologically with the newest ones on top. * List items are to be ordered chronologically with the newest ones on top.