diff --git a/.github/workflows/render-docs.yml b/.github/workflows/render-docs.yml
index c5c83dfc..3d8b5fc3 100644
--- 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
index 58a73098..a3a5ef5e 100644
--- 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
new file mode 100644
index 00000000..0c1dea7a
Binary files /dev/null and b/docs/source/example_cora_graph.png differ
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 151291c6..dea79647 100644
--- 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
index ff523d38..8af6fedf 100644
--- a/docs/source/themes/sphinx_neo4j/layout.html
+++ b/docs/source/themes/sphinx_neo4j/layout.html
@@ -20,20 +20,13 @@
@@ -68,4 +61,4 @@
{% endif %}
{%- endblock %}
-