sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
523 stars 75 forks source link

Print a banner when documentation is not fully succesfull #132

Open HealthyPear opened 11 months ago

HealthyPear commented 11 months ago

Context

In case of a warning or an error (or both, when using the sphinx -Woption) it would be nice to see a small orange or red banner in the live docs on top of the usual message to terminal, because from the build is not always obvious there is an issue.

Proposal

Add an HTML template with a simple banner and the debug message to the static material and use that when the build fails

Tasks and updates

No response

welcome[bot] commented 11 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: