Metadata-Version: 1.1
Name: changelog
Version: 0.5.3
Summary: Provides simple Sphinx markup to render changelog displays.
Home-page: http://bitbucket.org/zzzeek/changelog
Author: Mike Bayer
Author-email: mike@zzzcomputing.com
License: MIT
Description: ==========
        Changelog
        ==========
        
        A `Sphinx <http://sphinx.pocoo.org/>`_ extension to generate changelog files.
        
        This is an experimental, possibly-not-useful extension that's used by the
        `SQLAlchemy <http://www.sqlalchemy.org>`_ project and related projects.
        
        Configuration
        =============
        
        A sample configuration in ``conf.py`` looks like this::
        
            extensions = [
                        # changelog extension
                        'changelog',
        
                        # your other sphinx extensions
                        # ...
                    ]
        
        
            # section names - optional
            changelog_sections = ["general", "rendering", "tests"]
        
            # tags to sort on inside of sections - also optional
            changelog_inner_tag_sort = ["feature", "bug"]
        
            # 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"
        
        Usage
        =====
        
        Changelog introduces the ``changelog`` and ``change`` directives::
        
            ====================
            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 the ``changelog_sections``
        and ``changelog_inner_tag_sort`` configurations.
        
        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 the ``orm`` and ``declarative`` tags will be
        grouped under a section called ``orm declarative``, followed by the ``orm`` section where
        change entries that only have ``orm`` will be placed.
        
        Other Markup
        ============
        
        The ``:ticket:`` directive will make use of the ``changelog_render_ticket`` markup
        to render a ticket link::
        
            :ticket:`456`
        
        
        Other things not documented yet
        ===============================
        
        * the ``:version:`` directive, which indicates a changelog entry should be
          listed in other versions as well
        
        * the ``.. 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 file
        
        * the ``: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 possible
        
        * the ``changelog release-notes`` command 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 files
        
        * the changelog.rst -> markdown converter, used for web guis that want
          changelog sections written in markdown
        
        * the changelog.rst -> stream per changelog markdown API function, which can
          for example stream the changelogs per release to the github releases API
        
Keywords: Sphinx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
