Removing version number from sphinx-gallery and adding one line to th…

…e update_release_notes files
dtcenter · Sep 16, 2021 · 20bfaad · 20bfaad
1 parent 2ed9414
commit 20bfaad
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst b/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst
@@ -13,6 +13,11 @@ release. Open the following URL in a browser:
 
 * Update the release-notes.rst file found in the User's Guide directory.
 
+* Consider organizing release notes into logical groups
+  (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying
+  GitHub issue titles for consistency. The release notes should match
+  the GitHub issue titles, when possible.
+
 * Use your best judgement to apply bold formatting for any major or important changes.
 
 * When creating a bugfix release, leave the "Version X.Y.0 release notes

diff --git a/docs/Release_Guide/release_steps/update_release_notes_development.rst b/docs/Release_Guide/release_steps/update_release_notes_development.rst
@@ -13,6 +13,11 @@ release. Open the following URL in a browser:
 
 * Update the release-notes.rst file found in the User's Guide directory.
 
+* Consider organizing release notes into logical groups
+  (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying
+  GitHub issue titles for consistency. The release notes should match
+  the GitHub issue titles, when possible.
+
 * Use your best judgement to apply bold formatting for any major or important changes.
 
 * If you are creating a beta1 release, remove the previous version's release

diff --git a/docs/Release_Guide/release_steps/update_release_notes_official.rst b/docs/Release_Guide/release_steps/update_release_notes_official.rst
@@ -13,6 +13,11 @@ release. Open the following URL in a browser:
 
 * Update the release-notes.rst file found in the User's Guide directory.
 
+* Consider organizing release notes into logical groups
+  (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying
+  GitHub issue titles for consistency. The release notes should match
+  the GitHub issue titles, when possible.
+
 * Use your best judgement to apply bold formatting for any major or important changes.
 
 * When creating the official release, combine the beta release sections

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1 @@
-sphinx-gallery==0.7.0
+sphinx-gallery