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

Turn Sphinx warnings into errors in CI #2754

Merged
merged 7 commits into from
Feb 13, 2024

Conversation

yut23
Copy link
Collaborator

@yut23 yut23 commented Feb 12, 2024

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
Copy link
Collaborator Author

yut23 commented Feb 12, 2024

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.

@zingale zingale merged commit 62193e9 into AMReX-Astro:development Feb 13, 2024
20 checks passed
@yut23 yut23 deleted the sphinx_warnings_as_errors branch February 20, 2024 17:46
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