Turn Sphinx warnings into errors in CI

AMReX-Astro / Castro

Castro (Compressible Astrophysics): An adaptive mesh, astrophysical compressible (radiation-, magneto-) hydrodynamics simulation code for massively parallel CPU and GPU architectures.

http://amrex-astro.github.io/Castro

Other

299 stars 97 forks source link

Turn Sphinx warnings into errors in CI #2754

Closed yut23 closed 7 months ago

yut23 commented 7 months ago

PR summary

PR motivation

PR checklist

[ ] test suite needs to be run on this PR
[ ] this PR will change answers in the test suite to more than roundoff level
[ ] all newly-added functions have docstrings as per the coding conventions
[ ] the CHANGES file has been updated, if appropriate
[ ] if appropriate, this change is described in the docs

yut23 commented 7 months ago

For reference: Sphinx counts warnings through the logging framework, and doesn't distinguish between log levels, so errors and warnings are treated the same. The "Malformed table" and "line-length-limit" errors come from docutils.