FIX: plot directive raises warning on failing code (#30899) #30951
Conversation
|
Thank you for your contribution. Did you intend to add the |
|
I’m going to put this in draft for now. Overall it does not look like you pushed what you intended
Please mark this as "ready for review" when you are ready. In the meantime, if you need help, feel free to ask questions here. Or you may prefer to ask them in our incubator chat channel. |
|
Thanks for the review! I’ve pushed an update that ensures failures inside the plot directive are surfaced as proper warnings instead of being silently ignored. I verified the behavior locally using python -m sphinx -W on a minimal Sphinx project and confirmed that execution failures now produce warnings as expected. Please let me know if you’d like me to add a regression test in test_sphinxext.py. |
3 participants
Hey folks,
I noticed that the matplotlib plot directive wasn’t reporting any errors or warnings when the code it runs fails. Basically, it would silently move on, which can be confusing when building docs. This PR fixes that.
What’s changed:
-W.test_plot_directive_warns_on_failureto make sure this behavior is checked automatically.How I verified:
pytest -k test_plot_directive_warns_on_failureand it passespython -m sphinx -b html . _build -Wand the warning shows up as expectedThis should close #30899. Let me know if anything else is needed or if you spot any edge cases I missed.