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

Allow docs build on schedule #1772

Closed
Ianlmgoddard opened this issue Mar 3, 2022 · 2 comments · Fixed by #1773
Closed

Allow docs build on schedule #1772

Ianlmgoddard opened this issue Mar 3, 2022 · 2 comments · Fixed by #1773

Comments

@Ianlmgoddard
Copy link
Contributor

Would it be possible to allow doc deploys on schedule jobs? Currently the only events that trigger a docs build are push or `workflow_dispatch.

My use case: I have some examples in my package docs that pull and plot recent data, I think it would be nice if the docs had up to date plots. One possible way to do this is to set up the docs job to run on a schedule (via a github action), however this doesn't trigger a docs build because schedule events don't trigger builds.

Maybe a kwarg could be added to deploydocs? so the user could control which events they'd like to trigger builds.

@fredrikekre
Copy link
Member

Sure, do you want to make a patch? Should be roughly equivalent to this patch: 5f452f4

@Ianlmgoddard
Copy link
Contributor Author

Thanks for getting back to me, opened the PR #1773 (if that's not already obvious from above).

I diverted a bit from 5f452f4, because I thought the user would want control of whether or not to deploy the docs on schedule jobs. Happy to discuss here/on the PR.

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

Successfully merging a pull request may close this issue.

3 participants