Merge pull request #20711 from mantidproject/312_release_notes

Release notes for 3.12

docs/source/release/index.rst

@@ -6,6 +6,7 @@ Release Notes
    :maxdepth: 1
    :titlesonly:
 
+   v3.12.0 <v3.12.0/index>
    v3.11.0 <v3.11.0/index>
    v3.10.1 <v3.10.1/index>
    v3.10.0 <v3.10.0/index>

docs/source/release/v3.12.0/diffraction.rst

+===================
+Diffraction Changes
+===================
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+Powder Diffraction
+------------------
+
+Engineering Diffraction
+-----------------------
+
+Single Crystal Diffraction
+--------------------------
+
+Imaging
+-------
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file

docs/source/release/v3.12.0/framework.rst

+=================
+Framework Changes
+=================
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+Concepts
+--------
+
+Algorithms
+----------
+
+Data Objects
+------------
+
+Python
+------
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file

docs/source/release/v3.12.0/index.rst

+.. _v3.12.0:
+
+===========================
+Mantid 3.12.0 Release Notes
+===========================
+
+.. figure:: ../../images/ImageNotFound.png
+   :class: screenshot
+   :width: 385px
+   :align: right
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: This release is still under construction. The changes can be found in the nightly builds on the `download page`_.
+
+We are proud to announce version 3.12.0 of Mantid. This release
+celebrates 10 years of the Mantid project supporting Neutron and Muon
+research.
+
+**TODO: Add paragraph summarizing big changes**
+
+This is just one of many improvements in this release, so please take a
+look at the release notes, which are filled with details of the
+important changes and improvements in many areas. The development team
+has put a great effort into making all of these improvements within
+Mantid, and we would like to thank all of our beta testers for their
+time and effort helping us to make this another reliable version of Mantid.
+
+Throughout the Mantid project we put a lot of effort into ensuring
+Mantid is a robust and reliable product. Thank you to everyone that has
+reported any issues to us. Please keep on reporting any problems you
+have, or crashes that occur on our `forum`_.
+
+Installation packages can be found on our `download page`_
+which now links to sourceforge to mirror our download files around the world, you can also
+access the source code on `GitHub release page`_.
+
+Citation
+--------
+
+Please cite any usage of Mantid as follows: **TODO update with current version doi**
+
+- *Mantid 3.12.0: Manipulation and Analysis Toolkit for Instrument Data.; Mantid Project*. `doi: 10.5286/SOFTWARE/MANTID3.12.0 <http://dx.doi.org/10.5286/SOFTWARE/MANTID3.12.0>`_
+
+- Arnold, O. et al. *Mantid-Data Analysis and Visualization Package for Neutron Scattering and mu-SR Experiments.* Nuclear Instruments and Methods in Physics Research Section A: Accelerators, Spectrometers, Detectors and Associated Equipment 764 (2014): 156-166 `doi: 10.1016/j.nima.2014.07.029 <https://doi.org/10.1016/j.nima.2014.07.029>`_
+
+
+Changes
+-------
+
+.. toctree::
+   :titlesonly:
+
+   Framework <framework>
+   User Interface & Usability <ui>
+   Diffraction <diffraction>
+   LowQ <lowq>
+   Muon Analysis <muon>
+   Spectroscopy <spectroscopy>
+
+Full Change Listings
+--------------------
+
+For a full list of all issues addressed during this release please see the `GitHub milestone`_.
+
+.. _download page: http://download.mantidproject.org
+
+.. _forum: http://forum.mantidproject.org
+
+.. _GitHub milestone: http://github.com/mantidproject/mantid/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A"Release+3.12"+is%3Amerged
+
+.. _GitHub release page: https://github.com/mantidproject/mantid/releases/tag/v3.12.0

docs/source/release/v3.12.0/lowq.rst

+=============
+Low-Q Changes
+=============
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+Reflectometry
+-------------
+
+Small Angle Scattering
+----------------------
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file

docs/source/release/v3.12.0/muon.rst

+============
+MuSR Changes
+============
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file

docs/source/release/v3.12.0/spectroscopy.rst

+====================
+Spectroscopy Changes
+====================
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+Direct Geometry
+---------------
+
+Indirect Geometry
+-----------------
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file

docs/source/release/v3.12.0/ui.rst

+======================
+UI & Usability Changes
+======================
+
+.. contents:: Table of Contents
+   :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+    putting new features at the top of the section, followed by
+    improvements, followed by bug fixes.
+
+Installation
+------------
+
+Workbench
+---------
+
+SliceViewer and Vates Simple Interface
+--------------------------------------
+
+:ref:`Release 3.12.0 <v3.12.0>`
\ No newline at end of file