sphinxcontrib-towncrier
sphinxcontrib-towncrier copied to clipboard
sphinx-contrib
An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sph...
The current implementation relies on checking whether the string "No significant changes" is present in the command output: https://github.com/sphinx-contrib/sphinxcontrib-towncrier/blob/e58f24c/src/sphinxcontrib/towncrier/__init__.py#L78. That check is hardcoded but, in fact, this output may be...
I was writing contributing docs about Towncrier new fragments and realized that it's PITA to maintain a copy of `pyproject.toml` entries and not to forget to update entries in Sphinx...
Looks like the just-released Towncrier 24.7 has broken some API you're using: ```python-traceback Running Sphinx v7.4.7 loading translations [en]... done Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`. myst...
I see this warning when running the docs build for setuptools: ``` /Users/jaraco/code/pypa/setuptools/.tox/docs/lib/python3.12/site-packages/sphinxcontrib/towncrier/ext.py:66: EncodingWarning: 'encoding' argument not specified. towncrier_output = subprocess.check_output( # noqa: S603 ```
It's grown since I first wrote that paragraph in the README.
With older Towncriers being dropped, this should always work now.
Metadata
Owner
Metadata
An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sph...