summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJarrod Millman <jarrod.millman@gmail.com>2022-12-15 08:02:51 -0800
committerGitHub <noreply@github.com>2022-12-15 08:02:51 -0800
commit740e981a29385cafd6df3cd6c3d612f9e9e54b3d (patch)
treea96ba33744451f6b44404926ff397c82198f32dc /doc
parent6be702047b1bb596a8010cf80911bb6ea939b1d1 (diff)
downloadnetworkx-740e981a29385cafd6df3cd6c3d612f9e9e54b3d.tar.gz
Fix links in release notes (#6281)
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py10
-rw-r--r--doc/release/migration_guide_from_2.x_to_3.0.rst23
-rw-r--r--doc/release/release_dev.rst9
3 files changed, 15 insertions, 27 deletions
diff --git a/doc/conf.py b/doc/conf.py
index f5b6d55a..4059015c 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -222,11 +222,11 @@ latex_appendices = ["tutorial"]
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
- "neps": ("https://numpy.org/neps", None),
- "matplotlib": ("https://matplotlib.org/stable", None),
- "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
- "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
- "geopandas": ("https://geopandas.org/", None),
+ "neps": ("https://numpy.org/neps/", None),
+ "matplotlib": ("https://matplotlib.org/stable/", None),
+ "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+ "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
+ "geopandas": ("https://geopandas.org/en/stable/", None),
"pygraphviz": ("https://pygraphviz.github.io/documentation/stable/", None),
"sphinx-gallery": ("https://sphinx-gallery.github.io/stable/", None),
"nx-guides": ("https://networkx.org/nx-guides/", None),
diff --git a/doc/release/migration_guide_from_2.x_to_3.0.rst b/doc/release/migration_guide_from_2.x_to_3.0.rst
index a7dc8a4f..8035f4d3 100644
--- a/doc/release/migration_guide_from_2.x_to_3.0.rst
+++ b/doc/release/migration_guide_from_2.x_to_3.0.rst
@@ -1,8 +1,8 @@
:orphan:
-*****************************
-Preparing for the 3.0 release
-*****************************
+*******************************
+Migration guide from 2.X to 3.0
+*******************************
.. note::
Much of the work leading to the NetworkX 3.0 release will be included
@@ -11,7 +11,7 @@ Preparing for the 3.0 release
ongoing work and will help you understand what changes you can make now
to minimize the disruption caused by the move to 3.0.
-This is a guide for people moving from NetworkX 2.X to NetworkX 3.0
+This is a guide for people moving from NetworkX 2.X to NetworkX 3.0.
Any issues with these can be discussed on the `mailing list
<https://groups.google.com/forum/#!forum/networkx-discuss>`_.
@@ -34,9 +34,6 @@ structures (``Graph``, ``DiGraph``, etc.) and common algorithms, but some
functionality, e.g. functions found in the ``networkx.linalg`` package, are
only available if these additional libraries are installed.
-.. **TODO**: Generate a table showing dependencies of individual nx objects?
-.. Probably overkill...
-
Improved integration with scientific Python
-------------------------------------------
@@ -179,15 +176,7 @@ improving supported for array representations of multi-attribute adjacency::
Deprecated code
---------------
-The 2.6 release deprecates over 30 functions.
-See :ref:`networkx_2.6`.
-
-.. **TODO**: A table summarizing one deprecation per row w/ 3 columns: 1. the
-.. deprecated function, 2. the old usage, 3. the replacement usage.
-
----
-
-The functions `read_gpickle` and `write_gpickle` will be removed in 3.0.
+The functions `read_gpickle` and `write_gpickle` were removed in 3.0.
You can read and write NetworkX graphs as Python pickles.
>>> import pickle
@@ -199,7 +188,7 @@ You can read and write NetworkX graphs as Python pickles.
... G = pickle.load(f)
...
-The functions `read_yaml` and `write_yaml` will be removed in 3.0.
+The functions `read_yaml` and `write_yaml` were removed in 3.0.
You can read and write NetworkX graphs in YAML format
using pyyaml.
diff --git a/doc/release/release_dev.rst b/doc/release/release_dev.rst
index 94b62794..2e1b8447 100644
--- a/doc/release/release_dev.rst
+++ b/doc/release/release_dev.rst
@@ -16,9 +16,9 @@ Please send comments and questions to the `networkx-discuss mailing list
Highlights
----------
-This release is the result of 4 months of work with over 217 pull requests by
-37 contributors. We also have a :ref:`guide for people moving from NetworkX 2.X
-to NetworkX 3.0 <migration_guide_from_2.x_to_3.0>`. Highlights include:
+This release is the result of 8 months of work with over 217 pull requests by
+37 contributors. We also have a `guide for people moving from NetworkX 2.X
+to NetworkX 3.0 <https://networkx.org/documentation/latest/release/migration_guide_from_2.x_to_3.0.html>`. Highlights include:
- Better syncing between G._succ and G._adj for directed G.
And slightly better speed from all the core adjacency data structures.
@@ -42,8 +42,7 @@ to NetworkX 3.0 <migration_guide_from_2.x_to_3.0>`. Highlights include:
- We have added an experimental plugin feature which let users choose alternate
backends like GraphBLAS, CuGraph for computation. This is an opt-in feature and
may change in future releases.
-- Improved integration with the general Scientific Python ecosystem: <link to
- the migration guide section?>
+- Improved integration with the general `Scientific Python ecosystem <https://networkx.org/documentation/latest/release/migration_guide_from_2.x_to_3.0.html#improved-integration-with-scientific-python>`
Improvements
------------