Treat warnings as errors when building in CI

[sneakers-the-rat]

I think it's probably a good idea to treat warnings as errors to avoid simple mistakes - e.g. currently there is an admonition that uses an invalid color parameter:

python-package-guide/tutorials/publish-pypi.md

Line 215 in c487789

:color: secondary

and it's shown in CI: https://github.com/pyOpenSci/python-package-guide/actions/runs/15569974496/job/43843279611#step:10:80

but the build passes.

I think we should add the -W flag to the TEST_PARAMETERS so that would appear as an action failure in CI and prompt us to fix those before merging. This particular warning is not a huge deal, but this would also guard against invalid internal links and a variety of common low-grade problems that don't crash the build but either don't do what they should be doing or cause the document to not be rendered as expected

[lwasser]

I am OK with this! We could consider a workflow that if CI fails and it's a external contribution that didn't actually trigger that failure, we could then simply open an issue to make the fix.

[sneakers-the-rat]

not sure what you mean here, can you give an example?

these warnings happen during the build process and thus should be intrinsic to the document and so should always have been caused by the changes in the PR (not e.g. in something like the link checker where failures can be dependent on some external site being unavailable, which would not have been caused by the PR).