Add Tutorials to Documentation Page (#1768)

* Add tutorials * Add pandoc installation --------- Co-authored-by: Hiroshi Horii <[email protected]>
Qiskit · Apr 5, 2023 · fd8ada5 · fd8ada5
1 parent 1b866c6
commit fd8ada5
Show file tree

Hide file tree

Showing 13 changed files with 3,935 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -37,7 +37,7 @@ jobs:
           pip install -U pip virtualenv wheel
           pip install -U tox
           sudo apt-get update
-          sudo apt-get install -y build-essential libopenblas-dev
+          sudo apt-get install -y build-essential libopenblas-dev pandoc
         shell: bash
       - name: Run Docs Build
         run: tox -edocs

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -186,7 +186,8 @@ https://github.com/Qiskit/qiskit/blob/master/docs/release_notes.rst)
 
 Building The release notes are part of the standard qiskit-aer documentation
 builds. To check what the rendered HTML output of the release notes will look
-like for the current state of the repo, you can run: `tox -edocs` which will
+like for the current state of the repo, you need to install 
+[pandoc](https://pandoc.org/installing.html), then you can run: `tox -edocs` which will
 build all the documentation into `docs/_build/html` and the release notes in
 particular will be located at `docs/_build/html/release_notes.html`
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -53,6 +53,7 @@
 
 templates_path = ['_templates']
 
+
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -72,7 +73,8 @@
     'jupyter_sphinx',
     'reno.sphinxext',
     'matplotlib.sphinxext.plot_directive',
-    'sphinx.ext.intersphinx'
+    'sphinx.ext.intersphinx',
+    'nbsphinx'
 ]
 
 # -----------------------------------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,7 @@ https://github.com/Qiskit/qiskit-aer
     :hidden: 
 
     API Documentation <apidocs/aer>
+    Tutorials <tutorials/index>
     Release Notes <release_notes>
 
 .. Hiding - Indices and tables

diff --git a/docs/tutorials/1_aer_provider.ipynb b/docs/tutorials/1_aer_provider.ipynb
diff --git a/docs/tutorials/2_device_noise_simulation.ipynb b/docs/tutorials/2_device_noise_simulation.ipynb