readthedocs / ext-theme

Read the Docs drop in replacement site templates
2 stars 2 forks source link

Build pop-up: show error notification if the build has failed #413

Open humitos opened 2 months ago

humitos commented 2 months ago

I think these pop ups are cool. However, it doesn't provide too much extra useful information that the list item. The extra information it provides that's not in the list item is the commit (6225c4b5) and the build time (45 seconds). All the other data it shows in the list item:

Screenshot_2024-07-04_13-36-40

I think we can take advantage of this popup and add the reason for the build to fail here, for example. That way, users don't have to jump into the build details page to understand what happened:

Screenshot_2024-07-04_13-34-38

We could pull the error notifications and show them inside the popup. In this particular case, it would show: No HTML content found -- No content was output to the path "$READTHEDOCS_OUTPUT/html". Read more about where to put your built files.

agjohnson commented 2 months ago

This was already the case, at least previously:

image

I'm guessing the change to use build notifications might have broke this?