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 Read The Docs Autobuild for Pull Requests #2921

Closed
jtpio opened this issue Jul 14, 2020 · 9 comments
Closed

Enable Read The Docs Autobuild for Pull Requests #2921

jtpio opened this issue Jul 14, 2020 · 9 comments
Labels

Comments

@jtpio
Copy link
Member

jtpio commented Jul 14, 2020

It would be nice if we could enable the "Autobuild Documentation for Pull Requests" feature of Read the Docs for this repo.

As an example, this was recently enabled in voila:

And it looks like this:

image

Clicking on Details redirects to the built docs with a warning header at the top:

image

To make it work, we need to make sure to (if not already):

add 'jupyter-widgets' org in https://readthedocs.org/accounts/social/connections/

(from voila-dashboards/voila#650 (comment)).

This might also make it easier to contribute documentation changes.

@jtpio jtpio added the docs label Jul 14, 2020
@jtpio
Copy link
Member Author

jtpio commented Jul 14, 2020

cc @maartenbreddels

@martinRenou
Copy link
Member

👍 This would be really useful in ipyleaflet as well.

@jtpio
Copy link
Member Author

jtpio commented Feb 2, 2021

cc @willingc who might also be interested

@jtpio
Copy link
Member Author

jtpio commented Feb 3, 2021

Mentioning a couple more owners of the jupyter-widgets organization who could help with this:

@jasongrout @SylvainCorlay @vidartf @mwcraig

Thanks!

@mwcraig
Copy link
Contributor

mwcraig commented Feb 3, 2021

Looks like I'm not a maintainer on RTD. If I'm added I'm happy to flip the switch. This feature is really convenient.

@willingc
Copy link
Contributor

willingc commented Feb 6, 2021

@jtpio I added a RTD webhook here, and updated the builds with RTD. We should now have autobuilds on new merges. Closing this.

@willingc willingc closed this as completed Feb 6, 2021
@willingc willingc reopened this Feb 6, 2021
@willingc
Copy link
Contributor

willingc commented Feb 6, 2021

Oops I resolved the autobuilds on merge. The autobuild on PR is still needed.

@willingc
Copy link
Contributor

willingc commented Feb 6, 2021

OK. I've now enabled autobuild on PRs in the RTD advanced settings under Admin.

@willingc willingc closed this as completed Feb 6, 2021
@willingc
Copy link
Contributor

willingc commented Feb 6, 2021

Screen Shot 2021-02-06 at 2 30 08 PM

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

No branches or pull requests

4 participants