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

CI: verify docs are up to date #3217

Merged
merged 4 commits into from
Aug 7, 2024
Merged

CI: verify docs are up to date #3217

merged 4 commits into from
Aug 7, 2024

Conversation

pajod
Copy link
Contributor

@pajod pajod commented May 22, 2024

New CI task: complain if docs/source/settings.rst has changed after invoking sphinx-build, indicating someone (me) has forgotten to run make -C docs html

  • Its not a tox env because I found it easier to ask git whether the file has changed.
  • It will also fail if sphinx-build fails. This is good. We should know when that happens (note however, that this does not yet fail on a mistyped reference. that is, so far, just a warning.)

Proof that this works can be found in the earlier CI run of this very PR:

Assumption:

  • no need to duplicate between news.rst / 2023-news.rst - just move the content to referenced-in-toc subfiles when the main news file gets large.

re-apply typo fix from 628a0bc
reflect removal of setting from 555d2fa
@pajod
Copy link
Contributor Author

pajod commented Aug 7, 2024

(updated version now references unreleased 23.0.0 release)

@benoitc kind bump, this makes (at least properly rebased) PRs much more readable by avoiding having to merge settings.rst changes

@benoitc benoitc merged commit 56324be into benoitc:master Aug 7, 2024
24 checks passed
@benoitc
Copy link
Owner

benoitc commented Aug 7, 2024

thanks!

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

Successfully merging this pull request may close these issues.

2 participants