Developer documentation for python plotting interface(s)

[Federico M Pouzols]

After working on ticket #8912, it became obvious that a bit of documentation wouldn't do any harm and would actually save a lot of time. There should be some basic explanation of how qwt, qti, the sip bindings of qti, the mantidplot/proxies layer the traditional mantidplot module, and the new mantidplot/future module work and interact.

The doc will/should contain a diagram of layers, examples (now more or less included in the new mantidplot/future module), as well as notes on naming/renaming conventions and what works and how. Owen suggested that the document could be placed next to the new CLI design document: ​https://github.com/mantidproject/documents/blob/master/Design/Plotting/plotting_cli.md.

[Federico M Pouzols]

The document is on the documents repo: ​https://github.com/mantidproject/documents/blob/master/Design/Plotting/plotting_python_cpp_layers.md

[Federico M Pouzols]

This is now in the documentation repository: ​https://github.com/mantidproject/documents/blob/master/Design/Plotting/plotting_python_cpp_layers.md

To test:

• There are no code changes here, so it is not urgent at all to pass this ticket. The idea is that if you were to work on (or try to understand) future.pyplot this should be worth reading. Please check that the document is useful and provides a simple introduction to what components are involved in future.pyplot and why they are there. For example, is the diagram intuitive?
• Please feel very free to provide feedback and/or suggestions to improve it. More details could be added although in principle I'd like to keep it short, at the level of what's there and why + the main points to keep in mind when fiddling with future.pyplot and related layers/components.

[Roman Tolchenov]

The document is there and it give an overview of the python interface to MantidPlot. We have never had it before.

[Stuart Campbell]

This ticket has been transferred to github issue ​11395