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:
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
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
colorparameter:python-package-guide/tutorials/publish-pypi.md
Line 215 in c487789
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
-Wflag to theTEST_PARAMETERSso 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