Add notebooks to docs (#20)

* Changed settings to add notebooks in docs * Added Clifford RB notebook to docs * Removed notebook from old location * Reran notebook * Max depth of headings to 1 * Adapted heading levels in notebook * Update changelog * Add IQM logo file It is used by Sphinxh for documentation builds * Corrected link in changelog --------- Co-authored-by: Ricardas <ricardas.brazinskas@meetiqm.com>
iqm-finland · Dec 17, 2024 · 4571e7b · 4571e7b
1 parent b177630
commit 4571e7b
Show file tree

Hide file tree

Showing 9 changed files with 493 additions and 205 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,4 +31,7 @@ version.txt
 
 /Outputs/
 /tests/Outputs/
-/examples/Outputs/*
+/examples/Outputs/*
+
+# Exceptions
+!logo.png
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,10 @@
 Changelog
 =========
 
+Version 2.2
+===========
+* Added Clifford RB example notebook to docs. `#20 <https://github.com/iqm-finland/iqm-benchmarks/pull/20>`_
+
 Version 2.1
 ===========
 * Fixed bug in RB plots for individual decays.

diff --git a/docs/_static/images/logo.png b/docs/_static/images/logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
-    'myst_parser'
+    "myst_nb",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -162,6 +162,9 @@
     'mr': ('https://github.com/iqm-finland/iqm-benchmarks/pull/%s', 'MR '),
 }
 
+# -- Options for MyST-NB ---------------------------------------------------------
+nb_execution_mode = 'off'
+
 
 # -- Options for sphinxcontrib.bibtex -------------------------------------------------
 

diff --git a/docs/example_clifford_rb.ipynb b/docs/example_clifford_rb.ipynb
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,7 @@
+Examples
+########
+
+.. toctree::
+   :maxdepth: 1
+
+   example_clifford_rb
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ Contents
    :maxdepth: 2
 
    readme
+   examples
    API
    license
 

diff --git a/examples/example_clifford_rb.ipynb b/examples/example_clifford_rb.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ dependencies = [
     "pycurl >= 7.45.3, < 8.0",
     "xarray >= 2024.6.0, < 2025.0.0",
     "types-pycurl",
+    "myst-nb == 1.1.0",
 ]
 
 [project.urls]
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ Contents @@
        :maxdepth: 2
        readme
+       examples
        API
        license
@@ Expand Down @@