Include the future.pyplot module in the generated documentation

[Federico M Pouzols]

It should be included using the Sphinx automodule keyword: ​http://sphinx-doc.org/ext/autodoc.html

[Federico M Pouzols]

This is just to add the future.pyplot package documentation to the online docs, so we can link to it from the release notes.

[Federico Montesino Pouzols]

beautify sphinx generated doc, re #10761

Changeset: 832fe2186e46a7b34bc2f9749a9a91b7df49a3fb

[Federico Montesino Pouzols]

Add future.pyplot sphinx html docs, re #10761

Changeset: e6faa43225408ed919a963ef5266b5a0090ab25e

[Federico M Pouzols]

This is safe (and very convenient) to pass before beta testing starts.

To test: check that the documentation is generated correctly (make docs-html, may take a while), that it is in its proper place, looks fine, etc. The future.pyplot module documentation should be visible from the html documentation generated in your build directory: docs/html/api/python/index.html => docs/html/api/python/mantidplotlib/future/pyplot/index.html

Note: when this is passed, I have to remember to add the link here: http://www.mantidproject.org/ReleaseNotes_3_3_Framework_Changes#Python

[Martyn Gigg]

The clean builds haven't gone through yet but there are some documentation warnings that would be best address here. This is a snippet from my console log:

reading sources... [100%] interfaces/index                                                                                                                                                                           
/mnt/data1/GitHub/mantid-master/builds/relwithdbg/bin/pymantidplot/future/pyplot.py:docstring of pymantidplot.future.pyplot:143: WARNING: Title underline too short.

Plotting MD workspaces
---------------------
/mnt/data1/GitHub/mantid-master/builds/relwithdbg/bin/pymantidplot/future/pyplot.py:docstring of pymantidplot.future.pyplot:143: WARNING: Title underline too short.

Plotting MD workspaces
---------------------
/mnt/data1/GitHub/mantid-master/builds/relwithdbg/bin/pymantidplot/future/pyplot.py:docstring of pymantidplot.future.pyplot.plot:11: ERROR: Unexpected indentation.
/mnt/data1/GitHub/mantid-master/builds/relwithdbg/bin/pymantidplot/future/pyplot.py:docstring of pymantidplot.future.pyplot.plot:12: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] interfaces/index                                                                                                                                                                            
writing additional files... genindex py-modindex search
copying images... [100%] ../../../../builds/relwithdbg/docs/screenshots/SANSBeamFinder-v1_dlg.png                                                                                                                    
copying static files... done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 4 warnings.

[Lottie Greenwood]

Merge remote-tracking branch 'origin/feature/10761_include_future_pyplot_module_in_generated_doc'

Full changeset: ​0cc3fc09e587184d6cf0164d04e90a6db4ac9da8

[Stuart Campbell]

This ticket has been transferred to github issue ​11603