1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
Metadata-Version: 1.2
Name: releases
Version: 2.1.1
Summary: A Sphinx extension for changelog manipulation
Home-page: https://github.com/bitprophet/releases
Author: Jeff Forcier
Author-email: jeff@bitprophet.org
License: UNKNOWN
Project-URL: Docs, https://releases.readthedocs.io
Project-URL: Source, https://github.com/bitprophet/releases
Project-URL: Changelog, https://releases.readthedocs.io/en/latest/changelog.html
Project-URL: CI, https://app.circleci.com/pipelines/github/bitprophet/releases
Description: |version| |python| |license| |ci| |coverage|
.. |version| image:: https://img.shields.io/pypi/v/releases
:target: https://pypi.org/project/releases/
:alt: PyPI - Package Version
.. |python| image:: https://img.shields.io/pypi/pyversions/releases
:target: https://pypi.org/project/releases/
:alt: PyPI - Python Version
.. |license| image:: https://img.shields.io/pypi/l/releases
:target: https://github.com/bitprophet/releases/blob/main/LICENSE
:alt: PyPI - License
.. |ci| image:: https://img.shields.io/circleci/build/github/bitprophet/releases/main
:target: https://app.circleci.com/pipelines/github/bitprophet/releases
:alt: CircleCI
.. |coverage| image:: https://img.shields.io/codecov/c/gh/bitprophet/releases
:target: https://app.codecov.io/gh/bitprophet/releases
:alt: Codecov
What is Releases?
=================
Releases is a `Sphinx <http://sphinx-doc.org>`_ extension designed to help you
keep a source control friendly, merge friendly changelog file & turn it into
useful, human readable HTML output. It's compatible with Python 3.6+, and may
work on Sphinx versions as far back as 1.8.x, though 4.x and up are
recommended and generally all we will support.
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
<http://bitprophet.org/blog/2013/09/14/a-better-changelog/>`_.
For more documentation, please see http://releases.readthedocs.io. For a
roadmap, see the maintainer's `roadmap page
<http://bitprophet.org/projects#roadmap>`_.
.. note::
You can install the development version via ``pip install -e
git+https://github.com/bitprophet/releases/#egg=releases``.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.6
|
