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.dev70.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de1a41efb8ce722387b514ba973d3851a22c35967cf418dfb4ffd5ab9d8d0aee |
|
MD5 | c5fa6ce0bdb239bffa109983b9e53056 |
|
BLAKE2b-256 | 3bf3069321fbc514b983ac13f1bc0c508ec0abc49bfaf85b6bdb151a0438b0bb |
Hashes for sphinxcontrib_towncrier-0.2.1a1.dev70-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a43e80988470ff364830cad750dfdc70d44a4e9bf5d9d4a00d4ddbca6bb3b58 |
|
MD5 | d44750769ec705f53ec861d5942b6f97 |
|
BLAKE2b-256 | 68ff5b0098d272623e504c15bef9d9c290db06431c53a2118740184bea33916e |