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

Add script to verify that autogenerated docs are up to date #2916

Closed
mpenkov opened this issue Aug 16, 2020 · 1 comment · Fixed by #3329
Closed

Add script to verify that autogenerated docs are up to date #2916

mpenkov opened this issue Aug 16, 2020 · 1 comment · Fixed by #3329
Labels
documentation Current issue related to documentation housekeeping internal tasks and processes

Comments

@mpenkov
Copy link
Collaborator

mpenkov commented Aug 16, 2020

I see no real alternative either. Doesn't moving parts of our docs + testing elsewhere simply shift the problem around? That new place will still need testing, whenever things change. No difference.

Except code + docs in one place (=now) makes more sense conceptually IMO.

Yes, scripts / hooks that verify docs are in-sync, preferably at PR merge-time, would be nice.

Originally posted by @piskvorky in #2907 (comment)

@mpenkov mpenkov added documentation Current issue related to documentation housekeeping internal tasks and processes labels Aug 16, 2020
@mpenkov
Copy link
Collaborator Author

mpenkov commented Aug 16, 2020

During each PR build, our CI scripts should check that the autogenerated files are in sync with their parents. If they are out of sync, the CI build should crash. The PR author should then bring the files up to date and add them to the PR.

mpenkov added a commit that referenced this issue Apr 22, 2022
mpenkov added a commit that referenced this issue Apr 22, 2022
* Check gallery up to date as part of CI

Fix #2916

* tweak check_gallery.py

* update CI workflow

* update stale doc cache

* update stale docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Current issue related to documentation housekeeping internal tasks and processes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant