A Sphinx extension for changelog manipulation
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size releases-1.6.3-py2.py3-none-any.whl (22.1 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size releases-1.6.3.tar.gz (40.5 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for releases-1.6.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb3435ba372a6807433800fbe473760cfa781171513f670f3c4b76983ac80f18 |
|
MD5 | 51130de8b6fe27171a42cbcec969e8c1 |
|
BLAKE2-256 | 88bcfb9c5bf60b559a8fc6fffed54a83878b394cbedb4201d1e3aee3f9bbf659 |