Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Read the Docs build pull requests #1221

Open
paw-lu opened this issue Jun 7, 2022 · 1 comment
Open

Document Read the Docs build pull requests #1221

paw-lu opened this issue Jun 7, 2022 · 1 comment

Comments

@paw-lu
Copy link
Contributor

paw-lu commented Jun 7, 2022

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!

@cauliyang
Copy link
Contributor

I also meet the problem, bump sphnix to 5.0 will cause dependencies conflict. So I did not upgrade that 😑.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants