An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for slsh1o from gravatar.com slsh1o Avatar for webknjaz from gravatar.com webknjaz
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD 3-Clause License)
  • Author: Sviatoslav Sydorenko
  • Maintainer: Oleksiy Vasylyshyn
  • Requires: Python >=3.9
Classifiers
Report project as malware

Project description

SWUbanner sphinxcontrib-towncrier @ PyPI GitHub Actions CI/CD build status — Python package sphinxcontrib-towncrier coverage charts @ Covecov.io Documentation Status @ RTD

sphinxcontrib-towncrier

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version.

How to use this?

$ pip install sphinxcontrib-towncrier
extensions = ['sphinxcontrib.towncrier.ext']

# Options: draft/sphinx-version/sphinx-release
towncrier_draft_autoversion_mode = 'draft'
towncrier_draft_include_empty = True
towncrier_draft_working_directory = PROJECT_ROOT_DIR
# Not yet supported:
# towncrier_draft_config_path = 'pyproject.toml'  # relative to cwd

Make sure to point to the dir with pyproject.toml and pre-configure towncrier itself in the config.

If everything above is set up correctly, you should be able to add

.. towncrier-draft-entries::

to your documents, like changelog.rst. With no argument, the version title will be generated using the strategy set up in the towncrier_draft_autoversion_mode setting.

If you want to be in control, override it with an argument you like:

.. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]

Native RST substitutions in the argument work, just make sure to declare any non-default ones via rst_epilog or at the end of the document where the towncrier-draft-entries directive is being used.

Does anybody actually use this?

So far we know about two projects using sphinxcontrib-towncrier — ansible/pylibssh and pypa/pip. Also, this Sphinx extension is inspired by and somewhat based on the ideas used in pytest-dev/pytest and tox-dev/tox. We believe that these projects are full of wonderful tricks that you may want to explore regardless of whether you’ll use our project.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for slsh1o from gravatar.com slsh1o Avatar for webknjaz from gravatar.com webknjaz
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD 3-Clause License)
  • Author: Sviatoslav Sydorenko
  • Maintainer: Oleksiy Vasylyshyn
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

0.5.0a0 pre-release

0.4.0a0 pre-release

0.3.2a0 pre-release

0.3.1a3 pre-release

0.3.1a2 pre-release

0.3.1a1 pre-release

0.3.1a0 pre-release

0.3.0a0 pre-release

0.2.1a1.dev70 pre-release yanked

Reason this release was yanked:

This version wasn't supposed to reach the public PyPI

0.2.1a1.dev69 pre-release yanked

Reason this release was yanked:

This version wasn't supposed to reach the public PyPI

0.2.1a0 pre-release

0.2.0a0 pre-release

0.1.0a1 pre-release

Download files

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

Source Distribution

sphinxcontrib_towncrier-0.5.0a0.tar.gz (62.5 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_towncrier-0.5.0a0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib_towncrier-0.5.0a0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib_towncrier-0.5.0a0.tar.gz
Algorithm Hash digest
SHA256 294e69df6e275e7a86df7ea6a927cc7c28c2c370a884cd5c45de6ec989858f27
MD5 ccbfe2f9442ee2eb10cdc98313226e3f
BLAKE2b-256 21fe72ed57093e28af10595c50839b183c5fdf0952482e9ef0ca6eb90eb85c5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_towncrier-0.5.0a0.tar.gz:

Publisher: ci-cd.yml on sphinx-contrib/sphinxcontrib-towncrier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinxcontrib_towncrier-0.5.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_towncrier-0.5.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 11d130c3ad5e4649821d543c4ea7ab64bbe78df4d859ef94f4298e7845dc0f59
MD5 a4c3945f08f7139582b3a0b81384a3b9
BLAKE2b-256 ac5cf7e39f243636a5e1894f2f5a72579977bf3968922afdb75175ee45062066

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_towncrier-0.5.0a0-py3-none-any.whl:

Publisher: ci-cd.yml on sphinx-contrib/sphinxcontrib-towncrier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page