Skip to content

Document Read the Docs build pull requests #1221

@paw-lu

Description

@paw-lu

I was recently bitten by the sphinx incompatability with other documentation packages when it got bumped to 5.0. Similar to this repo:

But I didn't catch it on time—since all my testse passed—and merged it. I didn't know (until I looked at this repo and #1216) that Read the Docs can be configured to build docs based on PRs and check their success. Seems useful! Thanks!

Looked into it a bit, and I assume to get this check, you must enable preview Documentation from Pull Requests. I don't think this is mentioned in the Read the Docs section of the documenation. Would be nice to document it!

As always, would be glad to provide a PR!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions