Backend documentation

[tobias47n9e]

Is the backend documentation still up to date? e.g.: https://github.com/matplotlib/matplotlib/blob/master/doc/api/backend_gtkagg_api.rst

And is there a documentation for FigureCanvasGTK3Agg somewhere in the docs?

[tacaswell]

It looks like the auto-doc is not run on the gtk backend because you need an X-session to do so. I suspect the solution is to add a mock module so that we can import the mpl code without importing the gtk modules.

The backends in general are not as well documented as we would like, grep is your friend here 😉.

[tacaswell]

This is flagged to make sure that the text files for as many of the backends can be generate when we build the docs. I don't think we can actually hit all of them as the macosx and windows backends are mutually exclusive and neither are available on a linux box.

@mdboom How do we want to deal with this?

[mdboom]

It seems to me that since the backends all implement the same API, documenting backend_bases should be mostly enough. Maybe autodoc that and then add .rst files that describe any of the GUI-backent-specific differences...

[pelson]

Maybe autodoc that and then add .rst files that describe any of the GUI-backent-specific differences...

👍

[tacaswell]

Closing this as it is already done:

http://matplotlib.org/api/backend_bases_api.html