Package: changelog
ASphinxextension to generate changelog files.This is an experimental, possibly-not-useful extension that’s used by theSQLAlchemyproject and related projects.ConfigurationA sample configuration inconf.pylooks like this:extensions = [
            # changelog extension
            'changelog',

            # your other sphinx extensions
            # ...
        ]


# section names - optional
changelog_sections = ["general", "rendering", "tests"]

# section css classes - optional
changelog_caption_class = "caption"

# tags to sort on inside of sections - also optional
changelog_inner_tag_sort = ["feature", "bug"]

# whether sections should be hidden from tags list
changelog_hide_sections_from_tags = False

# whether tags should be hidden from entries
changelog_hide_tags_in_entry = False

# how to render changelog links - these are plain
# python string templates, ticket/pullreq/changeset number goes
# in "%s"
changelog_render_ticket = "http://bitbucket.org/myusername/myproject/issue/%s"
changelog_render_pullreq = "http://bitbucket.org/myusername/myproject/pullrequest/%s"
changelog_render_changeset = "http://bitbucket.org/myusername/myproject/changeset/%s"UsageChangelog introduces thechangelogandchangedirectives:====================
Changelog for 1.5.6
====================

.. changelog::
    :version: 1.5.6
    :released: Sun Oct 12 2008

    .. change::
        :tags: general
        :tickets: 27

      Improved the frobnozzle.

    .. change::
        :tags: rendering, tests
        :pullreq: 8
        :changeset: a9d7cc0b56c2

      Rendering tests now correctly render.With the above markup, the changes above will be rendered into document sections
per changelog, then each change within organized into paragraphs, including
special markup for tags, tickets mentioned, pull requests, changesets.   The entries will
be grouped and sorted by tag according to the configuration of thechangelog_sectionsandchangelog_inner_tag_sortconfigurations.A “compound tag” can also be used, if the configuration has a section like this:changelog_sections = ["orm declarative", "orm"]Then change entries which contain both theormanddeclarativetags will be
grouped under a section calledorm declarative, followed by theormsection where
change entries that only haveormwill be placed.Other MarkupThe:ticket:directive will make use of thechangelog_render_ticketmarkup
to render a ticket link::ticket:`456`Other things not documented yetthe:version:directive, which indicates a changelog entry should be
listed in other versions as wellthe.. changelog_imports::directive - reads other changelog.rst files
looking for:version:directives which apply to this changelog file,
adding those entries to the changelog entries in this filethe:include_notes_from:symbol - imports all the .rst files in a
directory into the current one so that changes can be one-per-file, makes
git merges possiblethechangelogrelease-notescommand that at release time gathers up
the above-mentioned change-per-file .rst files and renders them into the
main changelog.rst file, running “git rm” on the individual filesthe changelog.rst -> markdown converter, used for web guis that want
changelog sections written in markdownthe changelog.rst -> stream per changelog markdown API function, which can
for example stream the changelogs per release to the github releases API