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

Replace strict with warnonly and make makedocs builds fail by default #2194

Merged
merged 14 commits into from
Aug 15, 2023

Conversation

mortenpi
Copy link
Member

Close #2051.

@mortenpi mortenpi added this to the 1.0.0 milestone Aug 3, 2023
@mortenpi mortenpi marked this pull request as ready for review August 14, 2023 06:38
@mortenpi
Copy link
Member Author

This should be good to go now.

As for linkcheck: I've been going back and forth in my head about this, but my feeling right now is that we should keep that as false by default, because it's a bit flaky and also environment dependent. The checks that are on by default should be consistent. So the user should consciously opt-in to the online linkchecks.

One thing to note, though, is that if you set linkcheck = true, then linkcheck failures now do fail the build (unless you set warnonly = :linkcheck).

@mortenpi mortenpi merged commit dba6781 into master Aug 15, 2023
20 of 21 checks passed
@mortenpi mortenpi deleted the mp/strict-true branch August 15, 2023 06:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

strict=true & enable linkcheck by default
1 participant