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.1a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2a1f4ba5ebf1ae6ccac6d6ae918c10a186da4ab8f963e9dd31ebdeebb9191e2 |
|
MD5 | 340fb4835f351660c0db3735eb339969 |
|
BLAKE2b-256 | e6453a788cb7ee42cf8a2cede7429661a9f4250b712a4ff078325051b10ee5bd |
Hashes for sphinxcontrib_towncrier-0.3.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40c978cabc9f783973b7fb4e117f94a761736b86d91c76fad207619a3bd61767 |
|
MD5 | 449d4710abd6e50022a95cd9d9a88dbb |
|
BLAKE2b-256 | 2396107ed971be4e4a3706ae329fe7bb7546261a15f655e84e60852b69899910 |