DocumentationStyleGuide.rst

Documentation Style Guide

This guide describes the formatting that should be followed when documenting Mantid functionality. The documentation is built using Sphinx <http://sphinx.pocoo.org/> and when using Sphinx most of what you type is reStructuredText. For more information on reStructeredText see:

• https://pythonhosted.org/an_example_pypi_project/sphinx.html
• http://docutils.sourceforge.net/rst.html
• http://docutils.sourceforge.net/docs/user/rst/quickref.html
• http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt