Merge pull request #66 from neo4j/doc-notebooks

FlorentinD · web-flow · commit f21bd09bf4bf · 2025-01-22T11:25:48.000+01:00
Add notebooks to ref docs
diff --git a/.github/workflows/render-docs.yml b/.github/workflows/render-docs.yml
@@ -29,7 +29,12 @@ jobs:
           python-version: '3.11'
           cache: 'pip'
           cache-dependency-path: pyproject.toml
-      - run: pip install "python-wrapper/[dev, pandas, docs]"
+      - run: pip install "python-wrapper/[dev, pandas, gds, docs]"
+
+      - name: Setup pandoc
+        uses: pandoc/actions/setup@v1
+        with:
+          version: 3.6.2
 
       - name: Render ref docs
         run: ./scripts/render_docs.sh
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,11 +21,15 @@
     "sphinx.ext.autodoc",  # include docs from docstrings
     "enum_tools.autoenum",  # specialised autoclass for enums
     "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
+    "nbsphinx",  # support for jupyter notebooks
+    "nbsphinx_link",  # support for jupyter notebooks from other directories
 ]
 
 templates_path = ["_templates"]
 exclude_patterns: list[str] = []
 
+# -- Options for notebook extension -------------------------------------------
+nbsphinx_execute = "never"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
diff --git a/docs/source/example_cora_graph.png b/docs/source/example_cora_graph.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,10 +10,9 @@ This API reference manual lists all available endpoints in the `neo4j_viz` `pack
 
 
 .. toctree::
-   :maxdepth: 2
+   :glob:
+   :maxdepth: 1
    :caption: Contents:
 
-   from_gds
-   from_pandas
-   graph
-   render_options
+   *
+   tutorials/*
diff --git a/docs/source/themes/sphinx_neo4j/layout.html b/docs/source/themes/sphinx_neo4j/layout.html
@@ -20,20 +20,13 @@
   <nav class="navbar">
     <div class="navbar-brand">
       <a class="navbar-item" href="/">
-        <img class="navbar-logo" src="https://dist.neo4j.com/wp-content/uploads/20210422142941/neo4j-logo-2020.svg" alt="Neo4j Graph Data Science Client API Reference">
+        <img class="navbar-logo" src="https://dist.neo4j.com/wp-content/uploads/20210422142941/neo4j-logo-2020.svg" alt="Graph Visualization for Python API Reference">
       </a>
-      <a href="{{ pathto(root_doc) }}" class="navbar-item no-left-padding" aria-label="Neo4j Graph Data Science Client API Reference">
-        Graph Data Science Client API Reference
+      <a href="{{ pathto(root_doc) }}" class="navbar-item no-left-padding" aria-label="Graph Visualization for Python API Reference">
+        Graph Visualization for Python API Reference
       </a>
 
     </div>
-    <div id="topbar-nav" class="navbar-menu">
-      <div class="navbar-start">
-        <span class="navbar-link">
-          <a href="/docs/graph-data-science-client" class="project-link external">Graph Data Science Client docs</a>
-        </span>
-      </div>
-    </div>
   </nav>
 </header>
 
@@ -68,4 +61,4 @@
     <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-WK23PSS');</script>
   {% endif %}
 {%- endblock %}
-</body>
+</body>
diff --git a/docs/source/tutorials/example_cora_graph.png b/docs/source/tutorials/example_cora_graph.png
diff --git a/docs/source/tutorials/gds-nvl-example.nblink b/docs/source/tutorials/gds-nvl-example.nblink
@@ -0,0 +1,6 @@
+{
+  "path": "../../../examples/gds-nvl-example.ipynb",
+  "extra-media": [
+    "../../../examples/example_cora_graph.png"
+  ]
+}
diff --git a/docs/source/tutorials/neo4j-nvl-example.nblink b/docs/source/tutorials/neo4j-nvl-example.nblink
@@ -0,0 +1,3 @@
+{
+  "path": "../../../examples/neo4j-nvl-example.ipynb"
+}
diff --git a/docs/source/tutorials/snowpark-nvl-example.nblink b/docs/source/tutorials/snowpark-nvl-example.nblink
@@ -0,0 +1,3 @@
+{
+  "path": "../../../examples/snowpark-nvl-example.ipynb"
+}
diff --git a/examples/gds-nvl-example.ipynb b/examples/gds-nvl-example.ipynb
diff --git a/examples/neo4j-nvl-example.ipynb b/examples/neo4j-nvl-example.ipynb
@@ -5,9 +5,7 @@
    "id": "0d3ffc27",
    "metadata": {},
    "source": [
-    "# NVL Python Wrapper\n",
-    "\n",
-    "NVL (Neo4j Visualization Library) is a JavaScript library developed to display large graphs. This notebook showcases an experimental Python wrapper for this libary."
+    "# Visualizing Neo4j Graphs"
    ]
   },
   {
diff --git a/examples/snowpark-nvl-example.ipynb b/examples/snowpark-nvl-example.ipynb
diff --git a/python-wrapper/pyproject.toml b/python-wrapper/pyproject.toml
@@ -51,8 +51,9 @@ dev = [
 ]
 docs = [
     "sphinx==8.1.3",
-    "autodoc_pydantic",
-    "enum-tools[sphinx]"
+    "enum-tools[sphinx]",
+    "nbsphinx==0.9.6",
+    "nbsphinx-link==1.3.1",
 ]
 pandas = ["pandas>=2, <3", "pandas-stubs>=2, <3"]
 gds = ["graphdatascience>=1, <2"] # not compatible yet with Python 3.13

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "path": "../../../examples/neo4j-nvl-example.ipynb"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "path": "../../../examples/snowpark-nvl-example.ipynb"`
	`3`	`+}`