diff --git a/python/nx-cugraph/Makefile b/python/nx-cugraph/Makefile
index bd278ee477a..6500d834ee7 100644
--- a/python/nx-cugraph/Makefile
+++ b/python/nx-cugraph/Makefile
@@ -6,7 +6,7 @@ all: plugin-info lint readme
.PHONY: lint
lint:
- git ls-files | xargs pre-commit run --config lint.yaml --files
+ git ls-files | xargs pre-commit run --config lint.yaml --files || true
.PHONY: lint-update
lint-update:
@@ -17,7 +17,7 @@ plugin-info:
python _nx_cugraph/__init__.py
objects.inv:
- wget https://networkx.org/documentation/latest/objects.inv
+ wget https://networkx.org/documentation/stable/objects.inv
.PHONY: readme
readme: objects.inv
diff --git a/python/nx-cugraph/README.md b/python/nx-cugraph/README.md
index 60125d09f2a..8201dc34eb2 100644
--- a/python/nx-cugraph/README.md
+++ b/python/nx-cugraph/README.md
@@ -94,140 +94,140 @@ Below is the list of algorithms that are currently supported in nx-cugraph.
### [Algorithms](https://networkx.org/documentation/latest/reference/algorithms/index.html)
-bipartite
- ├─ basic
- │ └─ is_bipartite
- └─ generators
- └─ complete_bipartite_graph
-centrality
- ├─ betweenness
- │ ├─ betweenness_centrality
- │ └─ edge_betweenness_centrality
- ├─ degree_alg
- │ ├─ degree_centrality
- │ ├─ in_degree_centrality
- │ └─ out_degree_centrality
- ├─ eigenvector
- │ └─ eigenvector_centrality
- └─ katz
- └─ katz_centrality
-cluster
- ├─ average_clustering
- ├─ clustering
- ├─ transitivity
- └─ triangles
-community
- └─ louvain
- └─ louvain_communities
-components
- ├─ connected
- │ ├─ connected_components
- │ ├─ is_connected
- │ ├─ node_connected_component
- │ └─ number_connected_components
- └─ weakly_connected
- ├─ is_weakly_connected
- ├─ number_weakly_connected_components
- └─ weakly_connected_components
-core
- ├─ core_number
- └─ k_truss
-dag
- ├─ ancestors
- └─ descendants
-isolate
- ├─ is_isolate
- ├─ isolates
- └─ number_of_isolates
-link_analysis
- ├─ hits_alg
- │ └─ hits
- └─ pagerank_alg
- └─ pagerank
-operators
- └─ unary
- ├─ complement
- └─ reverse
-reciprocity
- ├─ overall_reciprocity
- └─ reciprocity
-shortest_paths
- └─ unweighted
- ├─ single_source_shortest_path_length
- └─ single_target_shortest_path_length
-traversal
- └─ breadth_first_search
- ├─ bfs_edges
- ├─ bfs_layers
- ├─ bfs_predecessors
- ├─ bfs_successors
- ├─ bfs_tree
- ├─ descendants_at_distance
- └─ generic_bfs_edges
-tree
- └─ recognition
- ├─ is_arborescence
- ├─ is_branching
- ├─ is_forest
- └─ is_tree
+bipartite
+ ├─ basic
+ │ └─ is_bipartite
+ └─ generators
+ └─ complete_bipartite_graph
+centrality
+ ├─ betweenness
+ │ ├─ betweenness_centrality
+ │ └─ edge_betweenness_centrality
+ ├─ degree_alg
+ │ ├─ degree_centrality
+ │ ├─ in_degree_centrality
+ │ └─ out_degree_centrality
+ ├─ eigenvector
+ │ └─ eigenvector_centrality
+ └─ katz
+ └─ katz_centrality
+cluster
+ ├─ average_clustering
+ ├─ clustering
+ ├─ transitivity
+ └─ triangles
+community
+ └─ louvain
+ └─ louvain_communities
+components
+ ├─ connected
+ │ ├─ connected_components
+ │ ├─ is_connected
+ │ ├─ node_connected_component
+ │ └─ number_connected_components
+ └─ weakly_connected
+ ├─ is_weakly_connected
+ ├─ number_weakly_connected_components
+ └─ weakly_connected_components
+core
+ ├─ core_number
+ └─ k_truss
+dag
+ ├─ ancestors
+ └─ descendants
+isolate
+ ├─ is_isolate
+ ├─ isolates
+ └─ number_of_isolates
+link_analysis
+ ├─ hits_alg
+ │ └─ hits
+ └─ pagerank_alg
+ └─ pagerank
+operators
+ └─ unary
+ ├─ complement
+ └─ reverse
+reciprocity
+ ├─ overall_reciprocity
+ └─ reciprocity
+shortest_paths
+ └─ unweighted
+ ├─ single_source_shortest_path_length
+ └─ single_target_shortest_path_length
+traversal
+ └─ breadth_first_search
+ ├─ bfs_edges
+ ├─ bfs_layers
+ ├─ bfs_predecessors
+ ├─ bfs_successors
+ ├─ bfs_tree
+ ├─ descendants_at_distance
+ └─ generic_bfs_edges
+tree
+ └─ recognition
+ ├─ is_arborescence
+ ├─ is_branching
+ ├─ is_forest
+ └─ is_tree
### [Generators](https://networkx.org/documentation/latest/reference/generators.html)
-classic
- ├─ barbell_graph
- ├─ circular_ladder_graph
- ├─ complete_graph
- ├─ complete_multipartite_graph
- ├─ cycle_graph
- ├─ empty_graph
- ├─ ladder_graph
- ├─ lollipop_graph
- ├─ null_graph
- ├─ path_graph
- ├─ star_graph
- ├─ tadpole_graph
- ├─ trivial_graph
- ├─ turan_graph
- └─ wheel_graph
-community
- └─ caveman_graph
-small
- ├─ bull_graph
- ├─ chvatal_graph
- ├─ cubical_graph
- ├─ desargues_graph
- ├─ diamond_graph
- ├─ dodecahedral_graph
- ├─ frucht_graph
- ├─ heawood_graph
- ├─ house_graph
- ├─ house_x_graph
- ├─ icosahedral_graph
- ├─ krackhardt_kite_graph
- ├─ moebius_kantor_graph
- ├─ octahedral_graph
- ├─ pappus_graph
- ├─ petersen_graph
- ├─ sedgewick_maze_graph
- ├─ tetrahedral_graph
- ├─ truncated_cube_graph
- ├─ truncated_tetrahedron_graph
- └─ tutte_graph
-social
- ├─ davis_southern_women_graph
- ├─ florentine_families_graph
- ├─ karate_club_graph
- └─ les_miserables_graph
+classic
+ ├─ barbell_graph
+ ├─ circular_ladder_graph
+ ├─ complete_graph
+ ├─ complete_multipartite_graph
+ ├─ cycle_graph
+ ├─ empty_graph
+ ├─ ladder_graph
+ ├─ lollipop_graph
+ ├─ null_graph
+ ├─ path_graph
+ ├─ star_graph
+ ├─ tadpole_graph
+ ├─ trivial_graph
+ ├─ turan_graph
+ └─ wheel_graph
+community
+ └─ caveman_graph
+small
+ ├─ bull_graph
+ ├─ chvatal_graph
+ ├─ cubical_graph
+ ├─ desargues_graph
+ ├─ diamond_graph
+ ├─ dodecahedral_graph
+ ├─ frucht_graph
+ ├─ heawood_graph
+ ├─ house_graph
+ ├─ house_x_graph
+ ├─ icosahedral_graph
+ ├─ krackhardt_kite_graph
+ ├─ moebius_kantor_graph
+ ├─ octahedral_graph
+ ├─ pappus_graph
+ ├─ petersen_graph
+ ├─ sedgewick_maze_graph
+ ├─ tetrahedral_graph
+ ├─ truncated_cube_graph
+ ├─ truncated_tetrahedron_graph
+ └─ tutte_graph
+social
+ ├─ davis_southern_women_graph
+ ├─ florentine_families_graph
+ ├─ karate_club_graph
+ └─ les_miserables_graph
### Other
-convert_matrix
- ├─ from_pandas_edgelist
- └─ from_scipy_sparse_array
+convert_matrix
+ ├─ from_pandas_edgelist
+ └─ from_scipy_sparse_array
To request nx-cugraph backend support for a NetworkX API that is not listed
diff --git a/python/nx-cugraph/scripts/update_readme.py b/python/nx-cugraph/scripts/update_readme.py
index 7b7f4b8b29d..1ab5a76c4c0 100644
--- a/python/nx-cugraph/scripts/update_readme.py
+++ b/python/nx-cugraph/scripts/update_readme.py
@@ -44,30 +44,30 @@ def replace_body(text, match, new_body):
# NetworkX isn't perfectly intersphinx-compatible, so manually specify some urls.
-# TODO: create networkx issue about intersphinx incompatibility
+# See: https://github.com/networkx/networkx/issues/7278
MANUAL_OBJECT_URLS = {
"networkx.algorithms.centrality.betweenness": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/centrality.html#shortest-path-betweenness"
),
"networkx.algorithms.centrality.degree_alg": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/centrality.html#degree"
),
"networkx.algorithms.centrality.eigenvector": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/centrality.html#eigenvector"
),
"networkx.algorithms.centrality.katz": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/centrality.html#eigenvector"
),
"networkx.algorithms.components.connected": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/component.html#connectivity"
),
"networkx.algorithms.components.weakly_connected": (
- "https://networkx.org/documentation/latest/reference/"
+ "https://networkx.org/documentation/stable/reference/"
"algorithms/component.html#weak-connectivity"
),
}
@@ -95,8 +95,7 @@ def main(readme_file, objects_filename):
objects_text = zlib.decompress(zlib_data).decode().strip()
objects_list = [parse_docobject(line) for line in objects_text.split("\n")]
doc_urls = {
- # Should we use latest or stable?
- obj.name: "https://networkx.org/documentation/latest/" + obj.uri
+ obj.name: "https://networkx.org/documentation/stable/" + obj.uri
for obj in objects_list
}
if len(objects_list) != len(doc_urls):