mkdocs-towncrier
An insanely small plugin to add towncrier changelog draft into mkdocs
Installation
You can install the package from PyPI using:
pip install -U mkdocs-towncrier
and then enabling it in your mkdocs.yml file:
plugins:
- towncrier
Usage
Using mkdocs-towncrier is as easy as adding a directive to wherever you want the draft changelog to be added:
# Changelog
<!--- You can even specify the header value! (defaults to "Unreleased") -->
:: towncrier-draft Unreleased changes
--8<-- "CHANGELOG.md"
And that's it! Any draft fragment files will be picked up and automatically added to your pages.
Acknowledgements
This project is heavily inspired in the wonderful sphinx-contrib/sphinxcontrib-towncrier!
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-towncrier 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_towncrier-0.1.6.tar.gz | 20.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_towncrier-0.1.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.2 kB
Release files / mkdocs_towncrier-0.1.6.tar.gz
| Download URL | mkdocs_towncrier-0.1.6.tar.gz |
|---|---|
| Size | 20.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a58b9eff5d7e580aeb7560839fd2d889949f8e9417f5c17f4f9008e6c48d4e13
|
|
BLAKE2b-256 checksum How to use checksums |
1223a7e2f7313a62524778f8c3e134c48f37b42cacece8147de52efcfb473b3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 12, 2026.
Transparency logRelease files / mkdocs_towncrier-0.1.6-py3-none-any.whl
| Download URL | mkdocs_towncrier-0.1.6-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9499d3a551bdb7a287debf139ebc624dce23b01e784384eec12f7b8f2b38dc2b
|
|
BLAKE2b-256 checksum How to use checksums |
a06f463eab8fada173a1272ad83c2ce2f84611b7eb1415f6991cc7ab1c66eb09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 12, 2026.
Transparency log
