Show examples in API reference

Co-authored-by: Nicola Vitucci <[email protected]>

Author: FlorentinD

docs/source/conf.py

@@ -33,7 +33,10 @@
 
 # -- Options for autodoc extension -------------------------------------------
 autodoc_typehints = "description"
+autoclass_content = "both"
 
+# -- Options for napoleon extension -------------------------------------------
+napoleon_use_admonition_for_examples = True
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

python-wrapper/src/neo4j_viz/visualization_graph.py

@@ -24,18 +24,27 @@
 
 # TODO helper for map properties to fields. helper for set caption (simplicity)
 class VisualizationGraph:
+    """
+    A graph to visualize.
+
+    The `VisualizationGraph` class represents a collection of nodes and relationships that can be
+    rendered as an interactive graph visualization. You can customize the appearance of nodes and
+    relationships by setting their properties, colors, sizes, and other visual attributes.
+    """
+
     #: "The nodes in the graph"
     nodes: list[Node]
     #: "The relationships in the graph"
     relationships: list[Relationship]
 
     def __init__(self, nodes: list[Node], relationships: list[Relationship]) -> None:
         """
-        A graph to visualize.
-
-        The `VisualizationGraph` class represents a collection of nodes and relationships that can be
-        rendered as an interactive graph visualization. You can customize the appearance of nodes and
-        relationships by setting their properties, colors, sizes, and other visual attributes.
+        Parameters
+        ----------
+        nodes : list[Node]
+            The nodes in the graph.
+        relationships : list[Relationship]
+            The relationships in the graph.
 
         Examples
         --------
@@ -71,19 +80,6 @@ def __init__(self, nodes: list[Node], relationships: list[Relationship]) -> None
         >>> # Use resize_nodes for automatic sizing
         >>> VG.resize_nodes(property="degree", node_radius_min_max=(10, 50))
 
-        Parameters
-        ----------
-        nodes : list[Node]
-            The nodes in the graph.
-        relationships : list[Relationship]
-            The relationships in the graph.
-
-        Attributes
-        ----------
-        nodes : list[Node]
-            The nodes in the graph.
-        relationships : list[Relationship]
-            The relationships in the graph.
         """
         self.nodes = nodes
         self.relationships = relationships
@@ -132,6 +128,12 @@ def render(
             The maximum allowed number of nodes to render.
         show_hover_tooltip:
             Whether to show an info tooltip when hovering over nodes and relationships.
+
+
+        Example
+        -------
+        Basic rendering of a VisualizationGraph:
+        >>> from neo4j_viz import Node, Relationship, VisualizationGraph
         """
 
         num_nodes = len(self.nodes)