From b491812779ee1cf0872dee9f4ffa757f461ad474 Mon Sep 17 00:00:00 2001 From: kc611 Date: Fri, 10 Mar 2023 18:32:17 +0530 Subject: [PATCH] Added orphan label where necessary --- docs/source/developer/contributing.rst | 2 +- docs/source/release/template.rst | 49 +++++++++++++++++++ .../upcoming_changes/8792.new_feature.rst | 1 + docs/{source => }/upcoming_changes/README.rst | 0 towncrier.toml | 12 ++--- 5 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 docs/source/release/template.rst rename docs/{source => }/upcoming_changes/8792.new_feature.rst (99%) rename docs/{source => }/upcoming_changes/README.rst (100%) diff --git a/docs/source/developer/contributing.rst b/docs/source/developer/contributing.rst index c8cfc065a91..4b1402cc962 100644 --- a/docs/source/developer/contributing.rst +++ b/docs/source/developer/contributing.rst @@ -325,7 +325,7 @@ Release Notes Pull Requests that add significant user-facing modifications, they may need to be mentioned in the release notes. To add a the release notes, you need to create a short ``.rst`` file with a summary and place it in -``docs/source/upcoming_changes``. The file ``docs/source/upcoming_changes/README.rst`` details the format +``docs/upcoming_changes``. The file ``docs/upcoming_changes/README.rst`` details the format and filename conventions. Stability diff --git a/docs/source/release/template.rst b/docs/source/release/template.rst new file mode 100644 index 00000000000..14e77420859 --- /dev/null +++ b/docs/source/release/template.rst @@ -0,0 +1,49 @@ +:orphan: + +========================== +Numba 0.xx.x Release Notes +========================== + + +Highlights +========== + + +NumPy Support +============= + + +Deprecations +============ + + +Future Changes +============== + + +Expired Deprecations +==================== + + +Compatibility Notes +=================== + + +CUDA API Changes +================ + + +New Features +============ + + +Improvements +============ + + +Performance Improvements and Changes +==================================== + + +Changes +======= diff --git a/docs/source/upcoming_changes/8792.new_feature.rst b/docs/upcoming_changes/8792.new_feature.rst similarity index 99% rename from docs/source/upcoming_changes/8792.new_feature.rst rename to docs/upcoming_changes/8792.new_feature.rst index f5414da9900..d29525825dc 100644 --- a/docs/source/upcoming_changes/8792.new_feature.rst +++ b/docs/upcoming_changes/8792.new_feature.rst @@ -1,3 +1,4 @@ + Added towncrier =============== diff --git a/docs/source/upcoming_changes/README.rst b/docs/upcoming_changes/README.rst similarity index 100% rename from docs/source/upcoming_changes/README.rst rename to docs/upcoming_changes/README.rst diff --git a/towncrier.toml b/towncrier.toml index 110c9305a13..f807f1a5166 100644 --- a/towncrier.toml +++ b/towncrier.toml @@ -1,7 +1,7 @@ [tool.towncrier] package = "numba" -directory = "docs/source/upcoming_changes" +directory = "docs/upcoming_changes" filename = "docs/source/release/{version}-notes.rst" [[tool.towncrier.type]] @@ -11,7 +11,7 @@ filename = "docs/source/release/{version}-notes.rst" [[tool.towncrier.type]] directory = "np_support" - name = "NumPy support" + name = "NumPy Support" showcontent = true [[tool.towncrier.type]] @@ -26,17 +26,17 @@ filename = "docs/source/release/{version}-notes.rst" [[tool.towncrier.type]] directory = "expired" - name = "Expired deprecations" + name = "Expired Deprecations" showcontent = true [[tool.towncrier.type]] directory = "compatibility" - name = "Compatibility notes" + name = "Compatibility Notes" showcontent = true [[tool.towncrier.type]] directory = "cuda" - name = "CUDA API changes" + name = "CUDA API Changes" showcontent = true [[tool.towncrier.type]] @@ -51,7 +51,7 @@ filename = "docs/source/release/{version}-notes.rst" [[tool.towncrier.type]] directory = "performance" - name = "Performance improvements and changes" + name = "Performance Improvements and Changes" showcontent = true [[tool.towncrier.type]]