An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version
Reason this release was yanked:
This version wasn't supposed to reach the public PyPI
Project description
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
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.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-towncrier-0.2.1a1.dev69.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02a3f8b1def9f7c623e777f766c3dd3d974a07c4323bfc99b4f27b7ded8122ed |
|
MD5 | 7a5cfc0ce9e711056b8b721d536900ee |
|
BLAKE2b-256 | 02a37571f355fd5741525dc70b28d0fd02e2753a6284c8966f3564f1e29ae154 |
Hashes for sphinxcontrib_towncrier-0.2.1a1.dev69-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44e6422e1d712bf22d35ea4ce3c47797c22c6ba4e384b90889d843554a3ac2ed |
|
MD5 | 44c9b0edbc58647d45cf2b81b51318d2 |
|
BLAKE2b-256 | 2ee266610703739135e5b28adcc794237720c243d47b0ad291a831ec8e5390bd |