Thanks for the patch, but that code is intended to be that way (check the paragraph before it.) The image shows three lines because plt.show is patched to do nothing when building docs, but I don't think there is any simple way to work around that.

Agreed with @QuLogic, proposing to close the PR.

If the image isn't able to show what the code does, especailly if it shows the contrary of what the code does, it should be removed. I also cannot think of another good visualization of this case.

My proposal would hence be to change the relevant part to

# restriction is lifted, so one can write a script like this::
#
#     import numpy as np
#     import matplotlib.pyplot as plt
#
#     plt.ioff()
#     for i in range(3):
#         plt.plot(np.random.rand(10))
#         plt.show()
#
# which makes three plots, one at a time. I.e. the second plot will show up,
# once the first plot is closed.

By the way, I think I know how to make this work in sphinx-exhibit, if there's still interest for that...

I don't currently see much of a use case for "making this work". In this case, you wouldn't want to clutter the tutorial with 3 images of those plots anyways, right?
In other cases, you would simply put plt.show() at the position where you want to show all figures. If sphinx-exhibit can defer output to the position where plt.show() is called, that may truely be useful. In general I think the only chance sphinx-exhibit has is to come along as a working solution.

I agree with @ImportanceOfBeingErnest 's change. I think that example is meant to show the workflow of

• plot something
• show the plot and let the GUI event loop block the rest of python
• when the user closes the plot window the script continues and opens the next widow
• repeat

There is no good way to show that in rendered static figures in the docs so it is better to just change it to a code block.

@anubhavshrimal Thanks for your work on this!

I don't currently see much of a use case for "making this work". In this case, you wouldn't want to clutter the tutorial with 3 images of those plots anyways, right?

In this specific case I agree

If sphinx-exhibit can defer output to the position where plt.show() is called, that may truely be useful.

That's what I had in mind.

Just to make sure how this is moving forwards,
@anubhavshrimal Are you willing to make the changes discussed above to this PR?

@ImportanceOfBeingErnest Though I would love to work on the discussed changes, I am not really sure how to go about doing that.

@anubhavshrimal it should really be as simple as mentionned above

My proposal would hence be to change the relevant part to

# restriction is lifted, so one can write a script like this::
#
#     import numpy as np
#     import matplotlib.pyplot as plt
#
#     plt.ioff()
#     for i in range(3):
#         plt.plot(np.random.rand(10))
#         plt.show()
#
# which makes three plots, one at a time. I.e. the second plot will show up,
# once the first plot is closed.

I have made some changes in the code and docs. Is that what you needed?
I thought it was something with sphinx-exhibit 😅 @ImportanceOfBeingErnest

That code block above was meant literally. The idea, as also stated by @tacaswell above

There is no good way to show that in rendered static figures in the docs so it is better to just change it to a code block.

would be to not generate any visual output for this code.

oh! So what I have understood is that you mean to comment out the rest of the code block as you have done?

Yes, exactly.

Done! Have a look. 👍

In principle yes, except you missed the double colon (::)

What now happened is that you have a trailing empty space in line 610 and 615. And also the indentation is wrong.

This is your proposed code:

This is my proposal from above:

The remaining error seems to come from

which should apparently read

    tutorials/introductory/usage.py: E501

instead. Can you change that as well and see if tests pass. (The codecov error is not important here, but continuous-integration tests need to pass.)

Sorry but I am not sure what you mean by E501

E501 is unimportant. The important part is to remove the E402 from the linked line.