skip to navigation
skip to content

releases 1.1.0

A Sphinx extension for changelog manipulation

What is Releases?

Releases is a Python 2+3 compatible Sphinx extension designed to help you keep a source control friendly, merge friendly changelog file & turn it into useful, human readable HTML output.

Specifically:

  • The source format (kept in your Sphinx tree as changelog.rst) is a stream-like timeline that plays well with source control & only requires one entry per change (even for changes that exist in multiple release lines).
  • The output (when you have the extension installed and run your Sphinx build command) is a traditional looking changelog page with a section for every release; multi-release issues are copied automatically into each release.
  • By default, feature and support issues are only displayed under feature releases, and bugs are only displayed under bugfix releases. This can be overridden on a per-issue basis.

Some background on why this tool was created can be found in this blog post.

For more documentation, please see http://releases.readthedocs.io.

Note

You can install the development version via pip install releases==dev.

 
File Type Py Version Uploaded on Size
releases-1.1.0-py2-none-any.whl (md5) Python Wheel py2 2016-04-29 12KB
releases-1.1.0.tar.gz (md5) Source 2016-04-29 29KB
  • Downloads (All Versions):
  • 0 downloads in the last day
  • 65 downloads in the last week
  • 990 downloads in the last month