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

docs are not built on RTD for a PR #156

Closed
orbeckst opened this issue Aug 1, 2021 · 9 comments
Closed

docs are not built on RTD for a PR #156

orbeckst opened this issue Aug 1, 2021 · 9 comments
Assignees
Labels
CI continuous integration docs

Comments

@orbeckst
Copy link
Member

orbeckst commented Aug 1, 2021

The "Build pull requests for this project " (under Advanced Settings on Read the Doc) should be enabled for alchemlyb. The corresponding webhook/integration should be enabled.

See also alchemistry/alchemtest#54

@orbeckst
Copy link
Member Author

orbeckst commented Aug 1, 2021

The setting is checked on RTD but something isn't working with the integration.

@orbeckst
Copy link
Member Author

Please see https://docs.readthedocs.io/en/stable/connected-accounts.html#github-permission-troubleshooting

You can also try rsyncing the webhook. On RTD go to the alchemtest project -> Admin -> Integrations: GitHub incoming webhook: Resync webook

This integration is being managed automatically by Read the Docs. If it isn't functioning correctly, try re-syncing the webhook:

readthedocs.org/api/v2/webhook/alchemlyb/131121/

When I try it, I get an error

Webhook activation failed. Make sure you have the necessary permissions.

Could someone with admin permissions on the alchemistry org please try that, e.g. @davidlmobley @dotsdl ?

@orbeckst
Copy link
Member Author

@dotsdl would you mind helping debugging the reason why we don't get docs built on RTD? PR reviews with doc changes (basically, all of them because we insist on documentation) are a lot easier when we can see the docs as well. Thank you!

@mikemhenry
Copy link

👋 @dotsdl if you add me (mmh) to the RTD project I can take a look at this, I recently fixed this issue in openmmtools

@dotsdl
Copy link
Member

dotsdl commented May 27, 2022

Added! Thank you for your help in maintaining these pipes @mikemhenry. Looking at this now as well.

@dotsdl
Copy link
Member

dotsdl commented May 27, 2022

@davidlmobley, @mrshirts, or @jchodera, would you mind adding me as an org Owner for alchemistry? @mikemhenry and I suspect (though aren't completely sure yet) that our ReadtheDocs issues are due to not having org-level OAuth permissions in place for ReadtheDocs, and I can't adjust these without the org-level Owner role.

@davidlmobley
Copy link

Done, @dotsdl

@dotsdl
Copy link
Member

dotsdl commented May 27, 2022

Awesome, thank you @davidlmobley! I accept that with great power comes great responsibility here.

@dotsdl
Copy link
Member

dotsdl commented May 27, 2022

See commentary in #195: we now have org-level authorization for ReadtheDocs that allows RTD to include a PR check linking to the doc build. Webhooks for both alchemlyb and alchemtest are working as expected.

Thanks to @mikemhenry for invaluable help in untangling this. Sorry for the long delay @orbeckst!

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

No branches or pull requests

4 participants