Adds the gallery example for mplcairo plotting

[Telomelonia]

PR Description

This example will go through how to blend two plots from SunPy using mplcairo.

Fixes #6517

TODO

• Create an example python file in plotting section for this tutorial
• Check if this is coming in sphinx-gallery docs or not.
• Changelog.

Issue

• If the mplcairo is not in local backend then its not working (try something by which this is not required)

[ayshih]

The PR is a good start, but you need to add mplcairo as a dependency for building the docs. We need to verify that the example will actually render for our online docs. Until that is verified, there's no point in polishing the example itself.

[Satan-Claws]

The PR is a good start, but you need to add mplcairo as a dependency for building the docs. We need to verify that the example will actually render for our online docs. Until that is verified, there's no point in polishing the example itself.

I've been trying to see if this works, but so far I've been having issues getting mplcairo working on Windows as well as Ubuntu.
For my base environment on Windows it installs correctly and the example works properly (displays and all) but I'm not able to get it working on the sunpy-dev environment (where Sphinx will make docs). I'll try it again on my base environment just to see if it renders correctly or not. If it does, I'll open a new PR and will let you know for changes. I'm still not sure why this happens on non-base environment, mplcairo is a bit buggy.

[nabobalis]

We do not want two open PRs fixing the same issue.

If @Telomelonia and @Satan-Claws can talk to each other and work on this example, that would be better.

[Telomelonia]

@Satan-Claws
The main problem is to make mplcairo work for sphinx-gallery to give output ig mplcairo need to be added as a dependency somewhere for it to give output ... else its showing an error.
If you want to work I can close this one.

[Telomelonia]

I've been trying to see if this works, but so far I've been having issues getting mplcairo working on Windows as well as Ubuntu. For my base environment on Windows it installs correctly and the example works properly (displays and all) but I'm not able to get it working on the sunpy-dev environment (where Sphinx will make docs). I'll try it again on my base environment just to see if it renders correctly or not. If it does, I'll open a new PR and will let you know for changes. I'm still not sure why this happens on non-base environment, mplcairo is a bit buggy.

Check here and this , it worked for me from the installation method mentioned

[Satan-Claws]

@Telomelonia no no don't close this PR, keep trying and I'll do the same, hopefully one of us gets it soon.

[Satan-Claws]

We do not want two open PRs fixing the same issue.

If @Telomelonia and @Satan-Claws can talk to each other and work on this example, that would be better.

Yeah makes sense

[Satan-Claws]

Built docs to check if @Telomelonia plotting built the gallery correctly, and this is the output I got. There are no errors but one plot is missing. I can send the html file if anyone needs.

[Telomelonia]

Thanks, @Satan-Claws, silly me ... I ignored the fact that axes and plots should be in one code block.

[ayshih]

@Telomelonia In case it wasn't apparent, I've been adding commits to your branch to try to get mplcairo to properly render the example

[Telomelonia]

@Telomelonia In case it wasn't apparent, I've been adding commits to your branch to try to get mplcairo to properly render the example

Thanks @ayshih ... I was struggling to work it out.

[ayshih]

Please don't change the order of the calls at the start of the example. It is formally required that the matplotlib.use() call comes before the import matplotlib.pyplot as plt line. pre-commit doesn't understand that, so it needs to be told to look the other way in this case.

[ayshih]

Okay, the example is working now and all spruced up. @Telomelonia should add a changelog entry. We can wait until sphinx-gallery puts out a new release before accepting this PR so that we don't have to use their development branch. (The reason that the build_docs-gallery build is failing is because I hadn't changed that to also use the sphinx-gallery development branch as I had with RTD.)

[ayshih]

I'd still prefer to hold off on merging this PR until the next version of sphinx-gallery is released so that we can remove the use of their development branch.

[nabobalis]

Works for me. Do we have an ETA on a new release?

[nabobalis]

The release came yesterday. We can now remove the git requirement and bump the min version to 0.13.

[nabobalis]

I rebased and tweaked the gallery version and removed the git requirement.

[nabobalis]

NOTE TO MAINAINTERS: SQUASH MERGE