Skip to content

Test news fragments #2068

Closed
Closed

Description

@stevepiercy

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.

How to write reStructuredText can be done by linking to https://icalendar.readthedocs.io/en/latest/contribute/documentation/style-guide.html#markup-examples and https://icalendar.readthedocs.io/en/latest/contribute/documentation/style-guide.html#cross-reference-python-objects. This is already done.

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.

What do y'all think?

Activity

  1. self-assigned this
    on Nov 7, 2026
  2. added
    github_actionsPull requests that update GitHub Actions code
    exemptExempt from pull request quality check workflow
    NLnetIssues and pull requests that qualify for NLnet funding.
    on Nov 7, 2026
  3. github-actions commented on Nov 7, 2026

    @github-actions
    Contributor

    Thanks for the issue, @stevepiercy! A maintainer will review it shortly.

  4. added a commit that references this issue on Nov 11, 2026
    e8d1d09
  5. SashankBhamidi commented on Nov 20, 2026

    @SashankBhamidi
    Member

    This is included in v8.0.0a1 (alpha).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

NLnetIssues and pull requests that qualify for NLnet funding.docexemptExempt from pull request quality check workflowfeaturegithub_actionsPull requests that update GitHub Actions code

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions