Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix all sphinx warnings during doc build. #7289

Merged
merged 1 commit into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/3d_drawing/plot_3d_rotation_animation.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=========================================
Animations of 3D rotation and random walk.
Animations of 3D rotation and random walk
=========================================
Examples of 3D plots of a graph in the 3D spectral layout with animation.
Following
Expand Down
8 changes: 4 additions & 4 deletions networkx/algorithms/operators/product.py
Original file line number Diff line number Diff line change
Expand Up @@ -546,11 +546,11 @@ def modular_product(G, H):
- if u is adjacent to x in `G` and v is adjacent to y in `H`, or
- if u is not adjacent to x in `G` and v is not adjacent to y in `H`.

More formally
::
More formally::

E(M) = {((u, v), (x, y)) | ((u, x) in E(G) and (v, y) in E(H)) or
((u, x) not in E(G) and (v, y) not in E(H))}

Parameters
----------
G, H: NetworkX graphs
Expand All @@ -559,12 +559,12 @@ def modular_product(G, H):
Returns
-------
M: NetworkX graph
The Modular product of G and H.
The Modular product of `G` and `H`.

Raises
------
NetworkXNotImplemented
If G is not a simple graph.
If `G` is not a simple graph.

Examples
--------
Expand Down
5 changes: 2 additions & 3 deletions networkx/generators/nonisomorphic_trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

@nx._dispatchable(graphs=None)
def nonisomorphic_trees(order, create="graph"):
"""Returns a list of nonisomorphic trees
"""Generates lists of nonisomorphic trees

Parameters
----------
Expand All @@ -31,8 +31,7 @@ def nonisomorphic_trees(order, create="graph"):
A list of nonisomorphic trees, in one of two formats depending on the
value of the `create` parameter:
- ``create="graph"``: yields a list of `networkx.Graph` instances
- ``create="matrix"``: yields a list of list-of-lists representing
adjacency matrices
- ``create="matrix"``: yields a list of list-of-lists representing adjacency matrices
"""

if order < 2:
Expand Down