Improve docs

.github/workflows/ci.yaml

@@ -24,6 +24,7 @@ jobs:
           python-version: '3.10'
       - name: Install dev-requirements
         run: |
+          sudo apt install pandoc
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt --no-cache-dir
         shell: bash

NOTICE.md

@@ -14,6 +14,8 @@ Our dependencies are (see [requirements.txt](requirements.txt)):
 
 We also use additional Python dependencies for development/testing/documentation (see [requirements-dev.txt](requirements-dev.txt)).
 
+The [tutorial notebook](docs/source/notebooks/ogb_biokg_demo.ipynb) make use of the [ogbl-biokg](https://ogb.stanford.edu/docs/linkprop/#ogbl-biokg) dataset, licensed under CC-0;
+
 ## Derived work
 
 This directory includes derived work from the following:

README.md

@@ -5,6 +5,8 @@ A Python toolbox to compute topological metrics and statistics for Knowledge Gra
 
 Documentation can be found at https://curly-barnacle-lnejye6.pages.github.io/
 
+For a walkthrough of the main functionalities, we provide an introductory [Jupyter notebook](docs/source/notebooks/ogb_biokg_demo.ipynb).
+
 ## Usage
 
 Tested on Ubuntu 20.04, Python >=3.8
@@ -18,7 +20,7 @@ pip install git+ssh://[email protected]/graphcore-research/kg-topology-toolbox
 
 4\. Import and use:
 ```python
-from kg_topology_toolbox import TopologyToolbox
+from kg_topology_toolbox import KGTopologyToolbox
 ```
 
 ## License
@@ -27,4 +29,4 @@ Copyright (c) 2023 Graphcore Ltd. Licensed under the MIT License.
 
 The included code is released under the MIT license (see [details of the license](LICENSE)).
 
-See [notices](NOTICE.md) for dependencies, credits, derived work and further details.
+See [notices](NOTICE.md) for dependencies, credits, derived work and further details.

docs/source/conf.py

@@ -36,6 +36,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.autosectionlabel",
     "myst_parser",
+    "nbsphinx",
 ]
 numpydoc_show_class_members = False
 todo_include_todos = True

docs/source/index.rst

@@ -8,4 +8,5 @@ KG Topology Toolbox
    :caption: Contents
 
    User guide <user_guide>
+   notebooks/ogb_biokg_demo
    API reference <API_reference>