adding notebooks to the doc

Author: Henri-ColibrITD

docs/_static/custom.css

@@ -30,97 +30,124 @@ div.document {
 
 /* *** fix for rtd dark *** */
 
+html[data-theme="dark"] div.nboutput.container div.output_area.stderr {
+  background: rgb(103, 23, 23);
+}
+
 html[data-theme="dark"] .sig > .sig-name > .pre {
-    color: white;
+  color: white;
 }
 
 html[data-theme="dark"] .highlight > pre > span.go {
-    color: rgb(173, 173, 173);
+  color: rgb(173, 173, 173);
 }
 
-html[data-theme="dark"].writer-html5 .rst-content 
-dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) 
-dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) > dt {
-    background-color: #0f0f0f;
-    color: #959595;
-    border-color: #2b2b2b;
+html[data-theme="dark"].writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(
+    .citation
+  ):not(.glossary):not(.simple)
+  dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(
+    .glossary
+  ):not(.simple)
+  > dt {
+  background-color: #0f0f0f;
+  color: #959595;
+  border-color: #2b2b2b;
 }
 
-html[data-theme="dark"].writer-html5 
-.rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not( .glossary ):not(.simple) 
-dl:not(.field-list) > dt {
-    color: #c6c6c6!important;
+html[data-theme="dark"].writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(
+    .glossary
+  ):not(.simple)
+  dl:not(.field-list)
+  > dt {
+  color: #c6c6c6 !important;
 }
 
 html[data-theme="dark"] .highlight > pre > span.n {
-    color: #80cb53;
+  color: #80cb53;
 }
 
 html[data-theme="dark"] .highlight > pre > span.o {
-    color: #cbcbcb;
+  color: #cbcbcb;
 }
 
 html[data-theme="dark"] .highlight > pre > span.nf,
 html[data-theme="dark"] .viewcode-block > span.nf {
-    color: #9975ec;
+  color: #9975ec;
 }
 
 html[data-theme="dark"] .highlight > .copybtn {
-    background-color: transparent;
-    color: aliceblue;
-    border: 1px solid aliceblue;
+  background-color: transparent;
+  color: aliceblue;
+  border: 1px solid aliceblue;
 }
 
 html[data-theme="dark"] .highlight > pre {
-    font-size: medium;
+  font-size: medium;
 }
 
 .wy-nav-content {
-    max-width: 1200px;
+  max-width: 1200px;
 }
 
-.class.enum > dd > dl:not(.method) .sig-name ~ *:not(:last-child):not(:nth-last-child(2)),
+.class.enum
+  > dd
+  > dl:not(.method)
+  .sig-name
+  ~ *:not(:last-child):not(:nth-last-child(2)),
 .class.enum > dd > .attribute > dt > .property,
 .attribute .sig-name ~ * {
-    display: none!important;
+  display: none !important;
 }
 
-
-[role='contentinfo'] {
-    float: right
+[role="contentinfo"] {
+  float: right;
 }
 
-html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .py.attribute,
-html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .py.property {
-    display: block;
-    margin-inline-end: 2em;
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(
+    .citation
+  ):not(.glossary):not(.simple)
+  .py.attribute,
+html.writer-html5
+  .rst-content
+  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(
+    .citation
+  ):not(.glossary):not(.simple)
+  .py.property {
+  display: block;
+  margin-inline-end: 2em;
 }
 
 .class:not(.enum) .py.attribute .sig-name::before {
-    content: 'attribute ';
-    font-style: italic;
-    color: #c6c6c6;
+  content: "attribute ";
+  font-style: italic;
+  color: #c6c6c6;
 }
 
 .wy-nav-side {
-    padding-bottom: 0;
+  padding-bottom: 0;
 }
 
 .class.enum > dd > .attribute,
 .class.enum > dd > .attribute * {
-    margin-bottom: 5px!important;
+  margin-bottom: 5px !important;
 }
 
 html[data-theme="dark"] .wy-nav-content > a {
-    color: #80cb53;
+  color: #80cb53;
 }
 
 html[data-theme="dark"] .wy-menu-vertical > p.caption {
-    color: #80cb53;
+  color: #80cb53;
 }
 
 html[data-theme="dark"] .wy-side-nav-search {
-    background-color: #0d0d0d;
+  background-color: #0d0d0d;
 }
 
 /*html[data-theme="dark"] .rst-content .admonition .admonition-title,

docs/conf.py

@@ -1,20 +1,22 @@
 from __future__ import annotations
+
+import os
+import sys
 from typing import Literal
+
 import dotenv
+from pygments.formatters.latex import LatexFormatter
 
 # Configuration file for the Sphinx documentation builder.
 from sphinx.application import Sphinx
 from sphinx.highlighting import PygmentsBridge
-from pygments.formatters.latex import LatexFormatter
 
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-import os
-import sys
 
 sys.path.insert(0, os.path.abspath("../"))
 
@@ -37,6 +39,8 @@
     "sphinx.ext.mathjax",
     "sphinx_rtd_dark_mode",
     "sphinx_copybutton",
+    "nbsphinx",  # requires pandoc ?
+    "nbsphinx_link",
 ]
 default_dark_mode = True
 autodoc_typehints = "description"
@@ -183,7 +187,8 @@
 # html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
+html_show_sourcelink = True
+html_sourcelink_suffix = ""
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = False

docs/examples.rst

@@ -0,0 +1,16 @@
+Examples
+========
+
+On this page, you will find a few notebooks we provide as examples for various
+MPQP features.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Notebooks:
+
+   notebooks_link/1_Basics_of_circuit
+   notebooks_link/2_Execution_Bell_circuit
+   notebooks_link/3_Expectation_value_of_observables
+   notebooks_link/4_Quantum_Fourier_Transform
+   notebooks_link/5_Variational_Quantum_Algorithms
+   notebooks_link/6_Pauli_string_observable

docs/index.rst

@@ -23,6 +23,7 @@ fluently.
    qasm
    tools
    changelog
+   examples
 
 Α full index can be found in the :ref:`genindex` page and a map of the module
 can be found in the :doc:`all-modules` page.

docs/notebooks_link/1_Basics_of_circuit.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/1_Basics_of_circuit.ipynb"
+}

docs/notebooks_link/2_Execution_Bell_circuit.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/2_Execution_Bell_circuit.ipynb"
+}

docs/notebooks_link/3_Expectation_value_of_observables.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/1_Basics_of_circuit.ipynb"
+}

docs/notebooks_link/4_Quantum_Fourier_Transform.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/4_Quantum_Fourier_Transform.ipynb"
+}

docs/notebooks_link/5_Variational_Quantum_Algorithms.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/5_Variational_Quantum_Algorithms.ipynb"
+}

docs/notebooks_link/6_Pauli_string_observable.nblink

@@ -0,0 +1,3 @@
+{
+  "path": "../../examples/notebooks/6_Pauli_string_observable.ipynb"
+}

requirements-dev.txt

@@ -4,4 +4,6 @@ pytest==7.1.1
 sphinx<5.2
 sphinx-rtd-dark-mode
 sphinx-copybutton
-sphinx_github_changelog
+sphinx_github_changelog
+nbsphinx
+nbsphinx_link