From 20bfaadd2030976a939cf5e8b9b47e014103b733 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 16 Sep 2021 14:05:18 -0600 Subject: [PATCH] Removing version number from sphinx-gallery and adding one line to the update_release_notes files --- .../release_steps/update_release_notes_bugfix.rst | 5 +++++ .../release_steps/update_release_notes_development.rst | 5 +++++ .../release_steps/update_release_notes_official.rst | 5 +++++ docs/requirements.txt | 2 +- 4 files changed, 16 insertions(+), 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 index c58225ba71..54882d1051 100644 --- 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 index 212eb2ab22..378b17fe00 100644 --- 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 index 5e3da21b70..f3c384e7bd 100644 --- 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 index 35ed837c5b..92245e5963 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -sphinx-gallery==0.7.0 +sphinx-gallery