made the notebooks works on docker, renamed the containing folder, and added a link to the notebook

Author: Henri-ColibrITD

Dockerfile

@@ -8,5 +8,6 @@ COPY requirements.txt /usr/src/app/
 
 RUN pip3 install --upgrade pip
 RUN pip3 install --no-cache-dir -r ../requirements-dev.txt
+RUN apt install pandoc
 
 COPY .. /usr/src/app/mpqp/

docs/conf.py

@@ -52,6 +52,32 @@
 if sphinx_github_changelog_token is not None:
     extensions.append("sphinx_github_changelog")
 
+# {% set docname = env.doc2path(env.docname,base=None).replace("\\", "/").split(".")[0].split("/")[-1] + '.ipynb' %}
+
+# .. raw:: html
+
+#     <div class="admonition note">
+#       This page was generated from the notebook
+#       <a class="reference external" href="{{ docname|e }}">{{ docname|e }}</a>.
+#     </div>
+
+nbsphinx_prolog = r"""
+{% set docname = 'examples/notebooks/' + env.doc2path(env.docname,base=None).split("/")[-1].split("\\")[-1].split(".")[0] + '.ipynb' %}
+
+.. raw:: html
+
+    <div class="admonition note">
+      This page was generated from the notebook
+      <a class="reference external" href="https://github.com/ColibrITD-SAS/mpqp/blob/main/{{ docname|e }}">{{ docname|e }}</a>.
+    </div>
+
+.. raw:: latex
+
+    \nbsphinxstartnotebook{\scriptsize\noindent\strut
+    \textcolor{gray}{The following section was generated from the notebook
+    \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
+"""
+
 # The suffix of source filenames.
 source_suffix = ".rst"
 

docs/examples.rst

@@ -8,9 +8,9 @@ MPQP features.
    :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
+   notebooks/1_Basics_of_circuit
+   notebooks/2_Execution_Bell_circuit
+   notebooks/3_Expectation_value_of_observables
+   notebooks/4_Quantum_Fourier_Transform
+   notebooks/5_Variational_Quantum_Algorithms
+   notebooks/6_Pauli_string_observable