|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``.
Raw data
{
"_id": null,
"home_page": "https://github.com/bitprophet/releases",
"name": "releases",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Jeff Forcier",
"author_email": "jeff@bitprophet.org",
"download_url": "https://files.pythonhosted.org/packages/71/a7/37cbf3e9f7c2591b4ba0453ef916cb2df9c4fd3cd06d5ddab2175a4c023b/releases-2.1.1.tar.gz",
"platform": null,
"description": "|version| |python| |license| |ci| |coverage|\n\n.. |version| image:: https://img.shields.io/pypi/v/releases\n :target: https://pypi.org/project/releases/\n :alt: PyPI - Package Version\n.. |python| image:: https://img.shields.io/pypi/pyversions/releases\n :target: https://pypi.org/project/releases/\n :alt: PyPI - Python Version\n.. |license| image:: https://img.shields.io/pypi/l/releases\n :target: https://github.com/bitprophet/releases/blob/main/LICENSE\n :alt: PyPI - License\n.. |ci| image:: https://img.shields.io/circleci/build/github/bitprophet/releases/main\n :target: https://app.circleci.com/pipelines/github/bitprophet/releases\n :alt: CircleCI\n.. |coverage| image:: https://img.shields.io/codecov/c/gh/bitprophet/releases\n :target: https://app.codecov.io/gh/bitprophet/releases\n :alt: Codecov\n\n\nWhat is Releases?\n=================\n\nReleases is a `Sphinx <http://sphinx-doc.org>`_ extension designed to help you\nkeep a source control friendly, merge friendly changelog file & turn it into\nuseful, human readable HTML output. It's compatible with Python 3.6+, and may\nwork on Sphinx versions as far back as 1.8.x, though 4.x and up are\nrecommended and generally all we will support.\n\nSpecifically:\n\n* The source format (kept in your Sphinx tree as ``changelog.rst``) is a\n stream-like timeline that plays well with source control & only requires one\n entry per change (even for changes that exist in multiple release lines).\n* The output (when you have the extension installed and run your Sphinx build\n command) is a traditional looking changelog page with a section for every\n release; multi-release issues are copied automatically into each release.\n* By default, feature and support issues are only displayed under feature\n releases, and bugs are only displayed under bugfix releases. This can be\n overridden on a per-issue basis.\n\nSome background on why this tool was created can be found in `this blog post\n<http://bitprophet.org/blog/2013/09/14/a-better-changelog/>`_.\n\nFor more documentation, please see http://releases.readthedocs.io. For a\nroadmap, see the maintainer's `roadmap page\n<http://bitprophet.org/projects#roadmap>`_.\n\n.. note::\n You can install the development version via ``pip install -e\n git+https://github.com/bitprophet/releases/#egg=releases``.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Sphinx extension for changelog manipulation",
"version": "2.1.1",
"project_urls": {
"CI": "https://app.circleci.com/pipelines/github/bitprophet/releases",
"Changelog": "https://releases.readthedocs.io/en/latest/changelog.html",
"Docs": "https://releases.readthedocs.io",
"Homepage": "https://github.com/bitprophet/releases",
"Source": "https://github.com/bitprophet/releases"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e059e0553803381b24d6e807bcbc1d1c5c11610dfefa70772eee36773d40dbc",
"md5": "3c5ea343c51363b2b8da131daa70a79d",
"sha256": "cd06449c915ce9729aaebe19a836744998f83f9ebb0cf92e54949c88ab3402f1"
},
"downloads": -1,
"filename": "releases-2.1.1-py3-none-any.whl",
"has_sig": true,
"md5_digest": "3c5ea343c51363b2b8da131daa70a79d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20969,
"upload_time": "2023-04-28T19:12:10",
"upload_time_iso_8601": "2023-04-28T19:12:10.907853Z",
"url": "https://files.pythonhosted.org/packages/2e/05/9e0553803381b24d6e807bcbc1d1c5c11610dfefa70772eee36773d40dbc/releases-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71a737cbf3e9f7c2591b4ba0453ef916cb2df9c4fd3cd06d5ddab2175a4c023b",
"md5": "9e9309dbe0f7acdd3e3d69e7e29a3730",
"sha256": "ae0683c3f309931a3717c6976e0f079929d05d34214b432a95764e61367f58d1"
},
"downloads": -1,
"filename": "releases-2.1.1.tar.gz",
"has_sig": true,
"md5_digest": "9e9309dbe0f7acdd3e3d69e7e29a3730",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 43034,
"upload_time": "2023-04-28T19:12:12",
"upload_time_iso_8601": "2023-04-28T19:12:12.259471Z",
"url": "https://files.pythonhosted.org/packages/71/a7/37cbf3e9f7c2591b4ba0453ef916cb2df9c4fd3cd06d5ddab2175a4c023b/releases-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 19:12:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "bitprophet",
"github_project": "releases",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"circle": true,
"lcname": "releases"
}
JSON
