You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Often news fragments lack links to the specific Python object, using inline literals instead. One of the barriers to using the Python domain is how to write them in the news fragments and test them.
Testing them is not yet done. They need to get included into the documentation and recognized by Sphinx. Currently that happens only at release time, when make changes is run. We don't want contributors to run this locally as it would remove all the unreleased news fragments and makes it difficult to find which entry in the long list is theirs alone.
I usually copy-paste the news fragment into index.rst and build the docs locally to test, edit as needed, and paste it back. Is there something better?
I propose to add make changes in the RTD PR preview, and use its diff feature to visually check. Then we'll get to see the end result and provide feedback.
Activity
github-actions commentedon Nov 7, 2026
Thanks for the issue, @stevepiercy! A maintainer will review it shortly.
Build the news fragments through Read the Docs preview for visual com…
SashankBhamidi commentedon Nov 20, 2026
This is included in v8.0.0a1 (alpha).