neo4j · adamnsch · Jan 24, 2025 · Jan 23, 2025 · Jan 23, 2025 · Jan 23, 2025
diff --git a/docs/extra/getting-started.ipynb b/docs/extra/getting-started.ipynb
diff --git a/docs/source/api-reference/graph.rst b/docs/source/api-reference/graph.rst
diff --git a/docs/source/api-reference/node.rst b/docs/source/api-reference/node.rst
@@ -0,0 +1,2 @@
+.. autoclass:: neo4j_viz.Node
+    :members:
diff --git a/docs/source/api-reference/relationship.rst b/docs/source/api-reference/relationship.rst
@@ -0,0 +1,2 @@
+.. autoclass:: neo4j_viz.Relationship
+    :members:
diff --git a/docs/source/api-reference/visualization-graph.rst b/docs/source/api-reference/visualization-graph.rst
@@ -0,0 +1,2 @@
+.. autoclass:: neo4j_viz.VisualizationGraph
+    :members:
diff --git a/docs/source/getting-started.nblink b/docs/source/getting-started.nblink
@@ -0,0 +1,3 @@
+{
+  "path": "../extra/getting-started.ipynb"
+}
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,15 +6,14 @@
 Graph Visualization for Python by Neo4j documentation
 =====================================================
 
-This is the documentation for the `neo4j_viz` Python library by Neo4j for creating interactive graph visualizations.
+This is the documentation for the `neo4j-viz` Python library by Neo4j for creating interactive graph visualizations.
 
 
 .. toctree::
    :glob:
    :maxdepth: 1
-   :caption: Contents:
 
    installation.rst
-   getting-started.rst
+   getting-started.nblink
    api-reference/index.rst
    tutorials/index.rst
diff --git a/docs/source/themes/sphinx_neo4j/static/css/neo4j.css b/docs/source/themes/sphinx_neo4j/static/css/neo4j.css
@@ -195,6 +195,12 @@ div.code-block-caption:hover > a.headerlink {
     padding: 0.25rem 0;
 }
 
+/* links */
+.doc span {
+    margin: 0;
+    padding: 0;
+}
+
 /* lists */
 
 body.sphinx .doc ul li{

diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst
@@ -6,7 +6,7 @@
 Tutorials
 =====================================================
 
-This chapter contains Jupyter notebook tutorials for the `neo4j_viz` package.
+This chapter contains Jupyter notebook tutorials for the `neo4j-viz` package.
 
 
 .. toctree::

diff --git a/python-wrapper/src/neo4j_viz/visualization_graph.py b/python-wrapper/src/neo4j_viz/visualization_graph.py
@@ -37,6 +37,33 @@ def render(
         allow_dynamic_min_zoom: bool = True,
         max_allowed_nodes: int = 10_000,
     ) -> HTML:
+        """
+        Render the graph.
+
+        Parameters
+        ----------
+        layout:
+            The `Layout` to use.
+        renderer:
+            The `Renderer` to use.
+        width:
+            The width of the rendered graph.
+        height:
+            The height of the rendered graph.
+        pan_position:
+            The initial pan position.
+        initial_zoom:
+            The initial zoom level.
+        min_zoom:
+            The minimum zoom level.
+        max_zoom:
+            The maximum zoom level.
+        allow_dynamic_min_zoom:
+            Whether to allow dynamic minimum zoom level.
+        max_allowed_nodes:
+            The maximum allowed number of nodes to render.
+        """
+
         num_nodes = len(self.nodes)
         if num_nodes > max_allowed_nodes:
             raise ValueError(
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. autoclass:: neo4j_viz.Node
		:members:
Comment on lines +1 to +2 Copy link Collaborator FlorentinD Jan 23, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. you could also try to use `automodule` to get all the classes automatically
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. autoclass:: neo4j_viz.Relationship
		:members:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. autoclass:: neo4j_viz.VisualizationGraph
		:members: