diff --git a/docs/changelog.rst b/docs/changelog.rst index 7820267..7a5e71e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -2,6 +2,11 @@ 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>` * :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 diff --git a/docs/usage.rst b/docs/usage.rst index 55e7673..72d1d30 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -32,13 +32,16 @@ Specifically: * You may optionally set ``releases_debug = True`` to see debug output while building your docs. -* Create a Sphinx document named ``changelog.rst`` with a top-level header - followed by a bulleted list. +* Create a Sphinx document named ``changelog.rst`` containing a bulleted list + somewhere at its topmost level. * If you wish to use a different document name, use another config option (as per previous bullet point), ``releases_document_name``. E.g. ``releases_document_name = "CHANGES"`` would cause Releases to mutate a 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.