192 add and test tutorials in documentation

.github/workflows/ci.yml

@@ -79,6 +79,9 @@ jobs:
           version: "0.6.14"
           python-version: "3.12"
 
+      - name: Install pandoc
+        uses: pandoc/actions/setup@v1
+
       - name: Install dependencies
         run: uv sync
 

.github/workflows/docs.yml

@@ -26,6 +26,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install pandoc
+        uses: pandoc/actions/setup@v1
+
       - name: Install uv
         uses: astral-sh/setup-uv@v5
         with:

docs/source/conf.py

@@ -42,6 +42,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinxcontrib.contentui",
+    "nbsphinx",
 ]
 
 # Add the numpydoc_show_inherited_class_members option
@@ -247,3 +248,5 @@ def run_apidoc(_):
 
 def setup(app):
     app.connect("builder-inited", run_apidoc)
+
+nbsphinx_allow_errors = True

docs/source/developer_guide/index.rst

@@ -146,7 +146,7 @@ Building the documentation
 Packages in the ``docs`` dependency group install `Sphinx <https://www.sphinx-doc.org>`_
 and other Python packages required to build ``aiida-mlip``'s documentation.
 
-Individual individual documentation pages can be edited directly::
+Individual documentation pages can be edited directly::
 
         docs/source/index.rst
         docs/source/developer_guide/index.rst

docs/source/user_guide/index.rst

@@ -10,3 +10,7 @@ User guide
     data
     calculations
     training
+    notebooks/singlepoint
+    notebooks/descriptors
+    notebooks/geometry-optimisation
+    notebooks/high-throughput-screening