Show pending newsfragments in documentation previews - #173
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #173 +/- ##
=======================================
Coverage 98.30% 98.30%
=======================================
Files 7 7
Lines 1298 1298
Branches 135 135
=======================================
Hits 1276 1276
Misses 12 12
Partials 10 10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
RazerM
force-pushed
the
feature/changelog-preview
branch
from
August 23, 2026 14:28
90d781c to
f36d8b5
Compare
sphinxcontrib-towncrier renders the newsfragments that have not been released yet at the top of the changelog, so that documentation previews built from pull requests include their entries. The title is now rendered by a custom towncrier template instead of title_format, so that the draft gets a plain "Unreleased" heading while releases keep their linked heading, unchanged.
RazerM
force-pushed
the
feature/changelog-preview
branch
from
August 23, 2026 14:32
f36d8b5 to
b09904d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds sphinxcontrib-towncrier so the changelog in documentation previews starts with an
Unreleasedsection (the Keep a Changelog convention) rendering the newsfragments that have not been released yet. The Read the Docs build of this PR shows the result for the fragments currently on main.As attrs does, the release title is now rendered by a towncrier template (
newsfragments/template.rst.jinja, the default RST template plus a branch on the version) rather thantitle_format, so the draft heading is a plainUnreleasedwhile release headings are unchanged — verified by diffing a fulltowncrier build --draftbefore and after.