Merge pull request #37744 from mantidproject/deprecation_removed_release_note_template

Update release notes template and generator

Author: rbauststfc

dev-docs/source/Standards/ReleaseNotesGuide.rst

@@ -73,6 +73,7 @@ Release note files need to be saved in the directory that best represents their
 or ``Bugfixes`` directory. For example a Bugfix release note for Engineering Diffraction should sit within ``/Diffraction/Engineering/Bugfixes`` .
 
 Release notes should not be placed in any directory outside of ``New_features`` or ``Bugfixes`` e.g. do not place release notes in ``/Diffraction/Engineering``. You should also not save release notes in any directory titled ``Used`` as this is for notes that have already been collated into the release notes.
+The only exception to this is for Algorithms and Fit Functions in the Framework Directory that additionally have ``Deprecated`` and ``Removed``.
 
 If you are uncertain where your release note should be see the :ref:`Standard File Structure <ReleaseNoteFileStructure>`.
 
@@ -191,11 +192,15 @@ This is the basic directory structure that is available to you for release notes
 
 	  + New features
 	  + Bugfixes
+	  + Deprecated
+	  + Removed
 
   - Fit Functions (Sub-heading)
 
 	  + New features
 	  + Bugfixes
+	  + Deprecated
+	  + Removed
 
   - Data Objects (Sub-heading)
 

docs/source/conf.py

@@ -237,4 +237,11 @@ def setup(app):
 # Suppress build warnings of the type:
 # "WARNING: document isn't included in any toctree"
 # for individual release notes files.
-exclude_patterns = ["release/templates/*.rst", "release/**/Bugfixes/*.rst", "release/**/New_features/*.rst", "release/**/Used/*.rst"]
+exclude_patterns = [
+    "release/templates/*.rst",
+    "release/**/Bugfixes/*.rst",
+    "release/**/New_features/*.rst",
+    "release/**/Used/*.rst",
+    "release/**/Removed/*.rst",
+    "release/**/Deprecated/*.rst",
+]

docs/source/release/templates/framework.rst

@@ -16,6 +16,14 @@ Bugfixes
 ############
 .. amalgamate:: Framework/Algorithms/Bugfixes
 
+Deprecated
+############
+.. amalgamate:: Framework/Algorithms/Deprecated
+
+Removed
+############
+.. amalgamate:: Framework/Algorithms/Removed
+
 Fit Functions
 -------------
 
@@ -27,6 +35,14 @@ Bugfixes
 ############
 .. amalgamate:: Framework/Fit_Functions/Bugfixes
 
+Deprecated
+############
+.. amalgamate:: Framework/Fit_Functions/Deprecated
+
+Removed
+############
+.. amalgamate:: Framework/Fit_Functions/Removed
+
 
 Data Objects
 ------------

tools/release_generator/release.py

@@ -131,6 +131,7 @@
 muon = ["FDA", "Muon_Analysis", "MA_FDA", "ALC", "Elemental_Analysis", "Algorithms"]
 
 subfolders = ["Bugfixes", "New_features"]
+deprecated_subfolders = subfolders + ["Deprecated", "Removed"]
 muon_subfolders = ["Bugfixes"]
 #################################################################################
 
@@ -225,18 +226,27 @@ def makeSubDirectoriesFromList(directoryList, upperDirectory, HigherLevel):
         makeReleaseNoteSubfolders(combinedDirectory, HigherLevel)
 
 
-def makeReleaseNoteSubfolders(directory, HigherLevel):
+def subfolder_creation(directory, HigherLevel, folder):
+    subfolderName = HigherLevel / directory / folder
+    subfolderName.mkdir(parents=True, exist_ok=True)
+    makeGitkeep(subfolderName)
+
+
+def getSubfoldersForDirectory(directory):
     directoryStr = str(directory)
-    for folder in subfolders:
-        if "Muon" in directoryStr:
-            for single_folder in muon_subfolders:
-                subfolderName = HigherLevel / directory / single_folder
-                subfolderName.mkdir(parents=True, exist_ok=True)
-                makeGitkeep(subfolderName)
-        else:
-            subfolderName = HigherLevel / directory / folder
-            subfolderName.mkdir(parents=True, exist_ok=True)
-            makeGitkeep(subfolderName)
+
+    if "Muon" in directoryStr:
+        return muon_subfolders
+
+    if "Framework" in directoryStr and ("Algorithm" in directoryStr or "Fit_Functions" in directoryStr):
+        return deprecated_subfolders
+
+    return subfolders
+
+
+def makeReleaseNoteSubfolders(directory, HigherLevel):
+    for folder in getSubfoldersForDirectory(directory):
+        subfolder_creation(directory, HigherLevel, folder)
 
 
 def makeGitkeep(subfolderName):