An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version
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.3.1a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 804d547b8d87270db43d7e57d6a0b9d989417ec3775256665f7b4e6d8c0a40de |
|
MD5 | 5f34e1f759dbc54f67877d1948d4b537 |
|
BLAKE2b-256 | 854b3c1269f14f07c36a9a9c935347c0106eae5176d5d7f19e6712e74f0d7cda |
Hashes for sphinxcontrib_towncrier-0.3.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f5eb4adc4361da286ff195e95ec36042f550c99171967a493fe219d258ad54c |
|
MD5 | dc62b2d5cd2aaa313088adb6f826a1bf |
|
BLAKE2b-256 | bf13e1035f6213d35dd0022dbcd68d388d3dbd115d9947db8f550d7b271e946a |