diff --git a/Code/Mantid/docs/DocumentationStyleGuide.md b/Code/Mantid/docs/DocumentationStyleGuide.md new file mode 100644 index 0000000000000000000000000000000000000000..75a0ac64a70cb8a18dc387da9a6cd2c8d5013ec7 --- /dev/null +++ b/Code/Mantid/docs/DocumentationStyleGuide.md @@ -0,0 +1,10 @@ +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 + diff --git a/Code/Mantid/docs/README.md b/Code/Mantid/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..12654d178542733afb2e6f43b05e16168c2ef5a4 --- /dev/null +++ b/Code/Mantid/docs/README.md @@ -0,0 +1,5 @@ +The Mantid documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and processed using [Sphinx](http://sphinx.pocoo.org/). To install Sphinx type + + easy_install -U Sphinx + +CMake produces a `doc-html` target that is used to build the documentation. The output files will appear in a `html` sub directory of the main `build/docs` directory. \ No newline at end of file