Prepare release notes for 0.8.0 release (#261)

* Prepare release notes for 0.8.0 release

This commit prepares the release notes for the 0.8.0 release. It bundles
all the release notes into a directory for the release and adds a
prelude section. Once this merges that commit should be tagged as 0.8.0
to indicate the release.

* Update releasenotes/notes/0.8.0/prepare-0.8-f3ec8cbf07dfdbb7.yaml

Co-authored-by: Lauren Capelluto <laurencapelluto@gmail.com>

releasenotes/notes/add-gc-integration-87f0d20a92b3e614.yaml → releasenotes/notes/0.8.0/add-gc-integration-87f0d20a92b3e614.yaml

@@ -3,7 +3,7 @@ fixes:
   - |
     In previous releases the Python garbage collector did not know how to
     interact with :class:`~retworkx.PyDiGraph` or :class:`~retworkx.PyGraph`
-    objects and as a result they would never be freed until Python exited.
+    objects and as a result they may never have been freed until Python exited.
     To fix this issue, the :class:`~retworkx.PyDiGraph` and
     :class:`~retworkx.PyGraph` classes now are integrated with Python's garbage
     collector so they'll properly be cleared when there are no more references

releasenotes/notes/0.8.0/add-is_matching-334626fe47e576be.yaml

@@ -0,0 +1,10 @@
+---
+features:
+  - |
+    A new algorithm function, :func:`~retworkx.is_matching`, was added to
+    check if a matching set is valid for given :class:`~retworkx.PyGraph`
+    object.
+  - |
+    A new algorithm function, :func:`~retworkx.is_maxmimal_matching`, was added
+    to check if a matching set is valid and maximal for a given
+    :class:`~retworkx.PyGraph` object.

releasenotes/notes/add-universal-functions-1e54351f1f7afa4b.yaml → releasenotes/notes/0.8.0/add-universal-functions-1e54351f1f7afa4b.yaml

@@ -1,9 +1,9 @@
 ---
 features:
   - |
-    New universal functions that can take in a :class:`~retworkx.PyGraph` or
-    :class:`~retworkx.PyDiGraph` instead of being class specific have been to
-    the retworkx API. These new functions are:
+    New :ref:`universal-functions` that can take in a :class:`~retworkx.PyGraph`
+    or :class:`~retworkx.PyDiGraph` instead of being class specific have been
+    to the retworkx API. These new functions are:
 
      * :func:`retworkx.distance_matrix`
      * :func:`retworkx.floyd_warshall_numpy`

releasenotes/notes/0.8.0/neighbors-fn-returns-unique-indices-00109eda7e3c9ee7.yaml

@@ -0,0 +1,7 @@
+---
+fixes:
+  - |
+    The output from :meth:`retworkx.PyDiGraph.neighbors`
+    and :meth:`retworkx.PyGraph.neighbors` methods will no longer
+    include duplicate entries in case of parallel edges between nodes. See
+    `#250 <https://github.com/Qiskit/retworkx/issues/250>`__ for more details.

releasenotes/notes/0.8.0/prepare-0.8-f3ec8cbf07dfdbb7.yaml

@@ -0,0 +1,13 @@
+---
+prelude: >
+    This release includes several new features and bug fixes. The main features
+    for this release are some usability improvements including the introduction
+    of new methods for interacting with edges, constructing graphs from
+    adjacency matrices, and :ref:`universal-functions` that are not strictly
+    typed and will work with either a :class:`~retworkx.PyGraph` or
+    :class:`~retworkx.PyDiGraph` object. It also includes new algorithm
+    functions around matchings for a :class:`~retworkx.PyGraph`, including a
+    function to find the maximum weight matching.
+
+    This is also the first release to include support and publishing of
+    precompiled binaries for Apple Arm CPUs on MacOS.

releasenotes/notes/return-class-object-methods-d8b19d952639118a.yaml → releasenotes/notes/0.8.0/return-class-object-methods-d8b19d952639118a.yaml

@@ -3,7 +3,7 @@ features:
   - |
     The custom return types :class:`~retworkx.BFSSuccessors`,
     :class:`~retworkx.NodeIndices`, :class:`~retworkx.EdgeList`, and
-    :class:`~retworkx.WeightedEdgeList` now implement ``_str__`` so that
+    :class:`~retworkx.WeightedEdgeList` now implement ``__str__`` so that
     running ``str()`` (for example when calling ``print()`` on the object) it
     will return a human readable string with the contents of the custom return
     type.
@@ -19,11 +19,10 @@ features:
     ``hash()`` on the inner unhashable object.
 fixes:
   - |
-    The custom return types :class:`~retworkx.BFSSuccessors`,
+    In previous releases the Python garbage collector did not know how to
+    interact with the custom return types :class:`~retworkx.BFSSuccessors`,
     :class:`~retworkx.NodeIndices`, :class:`~retworkx.EdgeList`, and
-    :class:`~retworkx.WeightedEdgeList` now are integrated with Python's
-    garbage collector so they'll properly be cleared when there are no more
-    Python references to an object. In previous releases the Python garbage
-    collector did not know how to interact with the custom return types and as
-    a result they would never be freed until Python exited. This has been fixed
-    by adding the garbage collection integration.
+    :class:`~retworkx.WeightedEdgeList` and as a result they may never have
+    been freed until Python exited. To fix this issue the custom return type
+    classes now are integrated with Python's garbage collector so they'll
+    properly be cleared when there are no more Python references to an object.