Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Sphinx extension for changelog manipulation

Project description

https://secure.travis-ci.org/bitprophet/releases.png?branch=master

What is Releases?

Releases is a Python (2.7, 3.4+) compatible Sphinx (1.3+) 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 -e git+https://github.com/bitprophet/releases/#egg=releases.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for releases, version 1.6.1
Filename, size File type Python version Upload date Hashes
Filename, size releases-1.6.1-py2.py3-none-any.whl (22.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size releases-1.6.1.tar.gz (42.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page