sphinx-themes / sphinx-themes.org

A showcase for Sphinx documentation themes
https://sphinx-themes.org
BSD 2-Clause "Simplified" License
236 stars 44 forks source link

Implement a more graceful failure approach #71

Closed pradyunsg closed 3 years ago

pradyunsg commented 3 years ago

It would likely be a good idea to change the render logic, to gracefully fail for themes that don't build properly, by printing out the information about them into the output and deploying it with that placeholder "it failed to render" messaging.

That would allow easier handling of cases like #70's breakages; pushing the responsibility to fix the theme-specific issues over to the theme authors more clearly.

pradyunsg commented 3 years ago

The approach that I have in mind is to capture the output of the commands executed by the workers, and place that output in a "this thing failed to build" placeholder HTML, that'll be used by the rest of the pipeline.

This also means that we'd show a "this theme is broken" image in the preview, which is a good thing.

pradyunsg commented 3 years ago

Fixed by #73.