couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Cottlehuber (JIRA)" <j...@apache.org>
Subject [jira] [Created] (COUCHDB-1579) Find a way to generate NEWS/CHANGES directly from .rst VERSION paragraph tag information
Date Sat, 27 Oct 2012 11:49:11 GMT
Dave Cottlehuber created COUCHDB-1579:
-----------------------------------------

             Summary: Find a way to generate NEWS/CHANGES directly from .rst VERSION paragraph
tag information
                 Key: COUCHDB-1579
                 URL: https://issues.apache.org/jira/browse/COUCHDB-1579
             Project: CouchDB
          Issue Type: New Feature
          Components: Build System, Documentation
    Affects Versions: 2.0
            Reporter: Dave Cottlehuber
            Priority: Minor
             Fix For: 2.0


Using http://sphinx.pocoo.org/markup/para.html#directive-versionadded tags it should be possible
to generate NEWS/CHANGES directly from committed documentation updates:

versionadded:: versionĀ¶

    This directive documents the version of the project which added the described feature
to the library or C API. When this applies to an entire module, it should be placed at the
top of the module section before any prose.

    The first argument must be given and is the version in question; you can add a second
argument consisting of a brief explanation of the change.

    Example:

    .. versionadded:: 2.5
       The *ham* parameter.

    Note that there must be no blank line between the directive head and the explanation;
this is to make these blocks visually continuous in the markup.

.. versionchanged:: 2.7
       The *ham* parameter became *spam*

    .. deprecated:: 3.1
       Use :func:`cram` instead.




--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message