Merge pull request #14204 from seberg/towncrier-renaming

DOC,MAINT: Move towncrier files and fixup categories

16 files changed, 65 insertions, 89 deletions

diff --git a/changelog/14036.expired.rst b/changelog/14036.expired.rst
deleted file mode 100644
index 5f83e1b67..000000000
--- a/changelog/14036.expired.rst
+++ /dev/null
@@ -1 +0,0 @@
-* PyArray_As1D, PyArray_As2D have been removed in favor of PyArray_AsCArray
\ No newline at end of file
diff --git a/changelog/14039.expired.rst b/changelog/14039.expired.rst
deleted file mode 100644
index 81a8160a8..000000000
--- a/changelog/14039.expired.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-*  ``np.rank`` has been removed. This was deprecated in NumPy 1.10
-   and has been replaced by ``np.ndim``.
diff --git a/changelog/14100.expired.rst b/changelog/14100.expired.rst
deleted file mode 100644
index 4597a8a25..000000000
--- a/changelog/14100.expired.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-* PyArray_FromDimsAndDataAndDescr has been removed, use PyArray_NewFromDescr instead
-* PyArray_FromDims has been removed, use PyArray_SimpleNew instead
\ No newline at end of file
diff --git a/changelog/14181.deprecation.rst b/changelog/14181.deprecation.rst
deleted file mode 100644
index 421dd9484..000000000
--- a/changelog/14181.deprecation.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-Deprecate `np.alen`
----------------------------------------------------------------
-`np.alen` was deprecated. Use `len` instead.
\ No newline at end of file
diff --git a/doc/RELEASE_WALKTHROUGH.rst.txt b/doc/RELEASE_WALKTHROUGH.rst.txt
index 445790709..bd3e3c124 100644
--- a/doc/RELEASE_WALKTHROUGH.rst.txt
+++ b/doc/RELEASE_WALKTHROUGH.rst.txt
@@ -41,7 +41,7 @@ Finish the Release Note
 .. note:
 
   This has changed now that we use ``towncrier``. See the instructions for
-  creating the release note in ``changelog/README.rst``.
+  creating the release note in ``doc/release/upcoming_changes/README.rst``.
 
 Fill out the release note ``doc/release/1.14.5-notes.rst`` calling out
 significant changes.
diff --git a/doc/release/1.18.0-notes.rst b/doc/release/1.18.0-notes.rst
index f20d5e3fe..04bfdb7fc 100644
--- a/doc/release/1.18.0-notes.rst
+++ b/doc/release/1.18.0-notes.rst
@@ -1,43 +1,8 @@
-==========================
-NumPy 1.18.0 Release Notes
-==========================
-
-
-Highlights
-==========
-
-
-New functions
-=============
-
-
-Deprecations
-============
-
-
-Future Changes
-==============
-
-
-Expired deprecations
-====================
-
-
-Compatibility notes
-===================
-
-
-C API changes
-=============
-
-
-New Features
-============
-
-
-Improvements
-============
-
-
-Changes
-=======
+The NumPy 1.18 release is currently in developement. Please check
+the ``numpy/doc/release/upcoming_changes/`` folder for upcoming
+release notes.
+The ``numpy/doc/release/upcoming_changes/README.txt`` details how
+to add new release notes.
+
+For the work in progress release notes for the current development
+version, see the `devdocs<https://numpy.org/devdocs/release.html>`.
diff --git a/changelog/13899.changes.rst b/doc/release/upcoming_changes/13899.change.rst
index da8277347..da8277347 100644
--- a/changelog/13899.changes.rst
+++ b/doc/release/upcoming_changes/13899.change.rst
diff --git a/doc/release/upcoming_changes/14036.expired.rst b/doc/release/upcoming_changes/14036.expired.rst
new file mode 100644
index 000000000..05164aa38
--- /dev/null
+++ b/doc/release/upcoming_changes/14036.expired.rst
@@ -0,0 +1,2 @@
+* ``PyArray_As1D`` and ``PyArray_As2D`` have been removed in favor of
+  ``PyArray_AsCArray``
diff --git a/doc/release/upcoming_changes/14039.expired.rst b/doc/release/upcoming_changes/14039.expired.rst
new file mode 100644
index 000000000..effee0626
--- /dev/null
+++ b/doc/release/upcoming_changes/14039.expired.rst
@@ -0,0 +1,2 @@
+* ``np.rank`` has been removed. This was deprecated in NumPy 1.10
+  and has been replaced by ``np.ndim``.
diff --git a/doc/release/upcoming_changes/14100.expired.rst b/doc/release/upcoming_changes/14100.expired.rst
new file mode 100644
index 000000000..953922c72
--- /dev/null
+++ b/doc/release/upcoming_changes/14100.expired.rst
@@ -0,0 +1,3 @@
+* ``PyArray_FromDimsAndDataAndDescr`` has been removed, use
+  ``PyArray_NewFromDescr`` instead
+* ``PyArray_FromDims`` has been removed, use ``PyArray_SimpleNew`` instead
diff --git a/doc/release/upcoming_changes/14181.deprecation.rst b/doc/release/upcoming_changes/14181.deprecation.rst
new file mode 100644
index 000000000..9979b2246
--- /dev/null
+++ b/doc/release/upcoming_changes/14181.deprecation.rst
@@ -0,0 +1,3 @@
+Deprecate `np.alen`
+-------------------
+`np.alen` was deprecated. Use `len` instead.
diff --git a/changelog/README.rst b/doc/release/upcoming_changes/README.rst
index 03f020c1e..fd35850e4 100644
--- a/changelog/README.rst
+++ b/doc/release/upcoming_changes/README.rst
@@ -20,26 +20,31 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
 * ``compatibility``: A change which requires users to change code and is not
   backwards compatible. (Not to be used for removal of deprecated features.)
 * ``c_api``: Changes in the Numpy C-API exported functions
-* ``new_features``: New user facing features like ``kwargs``.
-* ``improvements``: Performance and edge-case changes
-* ``changes``: Other changes
+* ``new_feature``: New user facing features like ``kwargs``.
+* ``improvement``: Performance and edge-case changes
+* ``change``: Other changes
+* ``highlight``: Adds a highlight bullet point to use as a possibly highlight
+  of the release.
 
-So for example: ``123.new_features.rst`` would have the content::
+Most categories shouldl be formatted as paragraphs with a heading.
+So for example: ``123.new_feature.rst`` would have the content::
 
-    my_new_feature option for `my_favorite_function`
-    ------------------------------------------------
+    ``my_new_feature`` option for `my_favorite_function`
+    ----------------------------------------------------
     The ``my_new_feature`` option is now available for `my_favorite_function`.
     To use it, write ``np.my_favorite_function(..., my_new_feature=True)``.
 
+``highlight`` is usually formatted as bulled points making the fragment
+``* This is a highlight``.
 
 Note the use of single-backticks to get an internal link (assuming
-``my_favorite_function`` is exported from the ``numpy`` namespace), and double-
-backticks for code.
+``my_favorite_function`` is exported from the ``numpy`` namespace),
+and double-backticks for code.
 
 If you are unsure what pull request type to use, don't hesitate to ask in your
 PR.
 
-You can install ``towncrier`` and run ``towncrier --draft --version NumPy``
+You can install ``towncrier`` and run ``towncrier --draft --version 1.18``
 if you want to get a preview of how your change will look in the final release
 notes.
 
diff --git a/changelog/template.rst b/doc/release/upcoming_changes/template.rst
index 21c4d19c6..21c4d19c6 100644
--- a/changelog/template.rst
+++ b/doc/release/upcoming_changes/template.rst
diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst
index 291b1df73..900431374 100644
--- a/doc/source/dev/development_workflow.rst
+++ b/doc/source/dev/development_workflow.rst
@@ -203,8 +203,9 @@ function, you should
   a description of and a motivation for your changes. This may generate
   changes and feedback. It might be prudent to start with this step if your
   change may be controversial.
-- add a release note to the ``changelog`` directory, following the instructions
-  and format in the ``changelog/README.rst`` file.
+- add a release note to the ``doc/release/upcoming_changes/`` directory,
+  following the instructions and format in the
+  ``doc/release/upcoming_changes/README.rst`` file.
 
 .. _rebasing-on-master:
 
diff --git a/doc/source/release.rst b/doc/source/release.rst
index 8dfb8db1d..f8d83726f 100644
--- a/doc/source/release.rst
+++ b/doc/source/release.rst
@@ -2,7 +2,6 @@
 Release Notes
 *************
 
-.. include:: ../release/1.18.0-notes.rst
 .. include:: ../release/1.17.0-notes.rst
 .. include:: ../release/1.16.4-notes.rst
 .. include:: ../release/1.16.3-notes.rst
diff --git a/pyproject.toml b/pyproject.toml
index 5c90ed3f8..949e12c9e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,12 +8,17 @@ requires = ["setuptools", "wheel", "cython"]  # PEP 508 specification
     # Use "--version Numpy" instead
     #project = "numpy"
     filename = "doc/release/latest-note.rst"
-    directory = "changelog/"
-    issue_format = "`#{issue} <https://github.com/numpy/numpy/pull/{issue}>`__"
-    template = "changelog/template.rst"
+    directory = "doc/release/upcoming_changes"
+    issue_format = "`gh-{issue} <https://github.com/numpy/numpy/pull/{issue}>`__"
+    template = "doc/release/upcoming_changes/template.rst"
     underlines="~="
 
     [[tool.towncrier.type]]
+        directory = "highlight"
+        name = "Highlights"
+        showcontent = true
+
+    [[tool.towncrier.type]]
         directory = "new_function"
         name = "New functions"
         showcontent = true
@@ -24,37 +29,36 @@ requires = ["setuptools", "wheel", "cython"]  # PEP 508 specification
         showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "future"
-      name = "Future Changes"
-      showcontent = true
+        directory = "future"
+        name = "Future Changes"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "expired"
-      name = "Expired deprecations"
-      showcontent = true
+        directory = "expired"
+        name = "Expired deprecations"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "coompatibility"
-      name = "Compatibility notes"
-      showcontent = true
+        directory = "compatibility"
+        name = "Compatibility notes"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "c_api"
-      name = "C API changes"
-      showcontent = true
+        directory = "c_api"
+        name = "C API changes"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "new_features"
-      name = "New Features"
-      showcontent = true
+        directory = "new_feature"
+        name = "New Features"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "improvements"
-      name = "Improvements"
-      showcontent = true
+        directory = "improvement"
+        name = "Improvements"
+        showcontent = true
 
     [[tool.towncrier.type]]
-      directory = "changes"
-      name = "Changes"
-      showcontent = true
-
+        directory = "change"
+        name = "Changes"
+        showcontent = true