Documentation clean up in new mantidplot future module

[Martyn Gigg]

The clean builds haven't gone through yet but there are some documentation warnings that would be best addressed 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.

A few other things could be addressed too:

• We should refer to matplotib in all lower case and not as MatPlotLib;
• We should include an index.rst file at docs/source/api/python/mantidplot/future/ that just lists the pyplot module
• We should include a link to the future module within docs/source/api/python/mantidplot/index.rst so that it is navigable without knowing where it is already.

[Federico Montesino Pouzols]

fix documentation warnings, re #10765

Changeset: d7145e2f78edf590b4c70551c40403db3240a369

[Federico Montesino Pouzols]

include future/index and link to it from mantiplot/index, re #10765

Changeset: d474aa03ed4ea970273a28c7788d23129feb02a5

[Federico Montesino Pouzols]

fix sphinx documentation details, re #10765

Changeset: 369e205f8e96fc0ca36be5490036a79e8cff13cf

[Federico M Pouzols]

Oops. thanks Martyn for spotting this in time. I've just fixed those docstring warnings, and also the other issues:

• there is a mantidplot/future/index that just lists the submodule future.pyplot
• the submodule mantidplot.future is listed in mantidplot/index

To test:

• this ticket fixes issues in the python API documentation just introduced in #10761
• check that the documentation of mantidplot.future.pyplot is fine, and navigable from mantidplot -> future -> pyplot

[Federico M Pouzols]

I think this is now fine. develop_clean finished and I didn't see any complaint from sphinx.

[Dan Nixon]

Merge remote-tracking branch 'origin/feature/10765_documentation_cleanup_new_mantidplot_future_module'

Full changeset: ​c31a79b166de6354d9fa9f1cbfba2bb4aebdd63e

[Stuart Campbell]

This ticket has been transferred to github issue ​11607