Skip to content

RTD pull request preview diff feature #2067

Closed

Description

@stevepiercy

Add a brief description and link to how to use the pull request preview diff feature on Read the Docs. Describe how this is useful. Also point to limitations and known issues.


Check how your change log entry renders in the pull request preview under the CI check for :guilabel:docs/readthedocs.org:icalendar then navigate to :menuselection:Reference guides --> Change log and search for your GitHub username.


I haven't evaluated all seven objects in the list to determine whether it would be a good idea for each to convert from generated to static docstrings, but I'm pretty sure that the two PRs are not good candidates for this based on where they end up in the rendered documentation. That problem has not been addressed, other than my pointing it out in one PR and you noticing that it "disappeared" in another:

Using the diff feature in Read the Docs is extremely helpful to see the changes. Try it out, and you'll see.

Image

The revisions to their docstring content is good, though.

Originally posted by @stevepiercy in #1650

Activity

  1. added this to the 8.0.0 milestone on Nov 6, 2026
  2. self-assigned this
    on Nov 6, 2026
  3. github-actions commented on Nov 6, 2026

    @github-actions
    Contributor

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

  4. 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

Type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions