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

Different build warnings are colored differently #9979

Closed
aofarrel opened this issue Dec 15, 2021 · 4 comments
Closed

Different build warnings are colored differently #9979

aofarrel opened this issue Dec 15, 2021 · 4 comments
Labels
Milestone

Comments

@aofarrel
Copy link

Describe the bug

Some types of warnings seem to be different colors than others. An image warning is light red, a transition warning is dark red. This behavior exists regardless of -W --keep-going being set.

How to Reproduce

$ git clone https://github.com/dockstore/dockstore-documentation.git
$ cd dockstore-documentation
$ git checkout make-html-warnings
$ pip install -r requirements.txt
$ cd docs
$ make html

Use the branch specified. I purposely broke an image's path to showcase the differently-colored warning so it's not on main or develop.

Expected behavior

Based on this, I'd expect all warnings to have the same color, and to not match the color of errors.

Your project

https://github.com/dockstore/dockstore-documentation/tree/make-html-warnings

Screenshots

Screenshot 2021-12-15 at 1 06 31 PM

OS

macOS 10.15.7 (Catalina)

Python version

3.7

Sphinx version

Sphinx v4.1.2

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

@tk0miya
Copy link
Member

tk0miya commented Dec 16, 2021

Oops. The labels of dark red messages are wrong. They should be "ERROR:" instead of "WARNING:". This must be a bug. Thank you for reporting.

@aofarrel
Copy link
Author

aofarrel commented Dec 16, 2021

When building this, the build will be reported as a success (assuming you don't set -W). Is a build success vs a build failure determined from the labeling? Asking because if so, we have had an error slip through our CI for quite some time now and will want to investigate that.

tk0miya added a commit that referenced this issue Dec 19, 2021
Fix #9979: Error level messages were displayed as warning messages
@tk0miya
Copy link
Member

tk0miya commented Dec 19, 2021

This error was raised from docutils; a framework library for document parsing and conversion. Sphinx does not exit (or crash) even if docutils raises an error. So it does not prevent building document if you don't set -W option. It's almost same as a warning. So I guess it's not related to your CI error.

@aofarrel
Copy link
Author

Thank you for the clarification, it's much appreciated.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants