https://github.com/bitprophet/releases

A powerful Sphinx changelog-generating extension.
https://github.com/bitprophet/releases

Last synced: 2 days ago
JSON representation

A powerful Sphinx changelog-generating extension.

• Host: GitHub
• URL: https://github.com/bitprophet/releases
• Owner: bitprophet
• License: bsd-2-clause
• Created: 2013-09-16T03:56:37.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-03-20T17:16:12.000Z (8 months ago)
• Last Synced: 2024-10-13T11:09:44.449Z (21 days ago)
• Language: Python
• Homepage: http://releases.readthedocs.io/
• Size: 553 KB
• Stars: 176
• Watchers: 7
• Forks: 41
• Open Issues: 32
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• best-of-python-dev - GitHub - 40% open · ⏱️ 01.12.2023): (Documentation)
• starred-awesome - releases - A powerful Sphinx changelog-generating extension. (Python)

README

        
|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 `_ 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

`_.

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

roadmap, see the maintainer's `roadmap page

`_.

.. note::

    You can install the development version via ``pip install -e

    git+https://github.com/bitprophet/releases/#egg=releases``.