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

Enable the ReadTheDocs PR Preview #1580

Closed
jtpio opened this issue May 11, 2022 · 5 comments
Closed

Enable the ReadTheDocs PR Preview #1580

jtpio opened this issue May 11, 2022 · 5 comments

Comments

@jtpio
Copy link
Member

jtpio commented May 11, 2022

The ReadTheDocs PR Preview feature is really useful to automatically build the docs when a new PR is opened.

We should consider enabling it for this repo. This would make reviewing documentation changes easier without having to build the changes locally. For example for #1577 which updated the way the changelog is handled.

Documentation on RTD: https://docs.readthedocs.io/en/stable/pull-requests.html

pr-preview

@jtpio
Copy link
Member Author

jtpio commented May 12, 2022

cc @jhamrick @BertR who might have access to the project on ReadTheDocs.

This should be available under the Advanced Settings:

image

@jhamrick
Copy link
Member

I enabled the setting!

@jtpio
Copy link
Member Author

jtpio commented May 18, 2022

Thanks!

Looks like the check is not visible though, for example on the recent #1584:

image

Not sure there is something else to enable to make it visible.

@jhamrick
Copy link
Member

jhamrick commented May 18, 2022 via email

@jtpio
Copy link
Member Author

jtpio commented May 18, 2022

Yes, looking good on #1586 now:

image

Thanks!

@jtpio jtpio closed this as completed May 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants