Docs: Add example notebooks

rigetti · Jul 21, 2021 · 9ac0be8 · 9ac0be8
1 parent de2ceb3
commit 9ac0be8
Show file tree

Hide file tree

Showing 7 changed files with 1,385 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -170,4 +170,4 @@ Dependencies are managed with [Poetry](https://python-poetry.org/) so you need t
 1. Check style only: `make check-style`
 1. Check types only: `make check-types`
 1. Reformat all code (to make `check-style` pass): `make format`
-1. Build documentation, serve locally, and watch for changes: `make watch-docs`
+1. Build documentation, serve locally, and watch for changes: `make watch-docs` (requires `docs` extra: `poetry install -E docs`)
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,6 +17,8 @@
     "autoapi.extension",
     "sphinx.ext.napoleon",
     "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.mathjax",
 ]
 
 source_suffix = {
@@ -44,6 +46,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+myst_update_mathjax = False
 
 # -- Options for HTML output -------------------------------------------------
 html_theme = "furo"

diff --git a/docs/examples/qaoa_pyquil.ipynb b/docs/examples/qaoa_pyquil.ipynb
diff --git a/docs/examples/qaoa_qiskit.ipynb b/docs/examples/qaoa_qiskit.ipynb
diff --git a/docs/index.md b/docs/index.md
@@ -9,6 +9,14 @@ This documentation supports light ☀️ and dark 🌙 modes and will automatica
     :end-before: Development
 ```
 
+```{toctree}
+   :maxdepth: 2
+   :caption: Examples
+   
+examples/qaoa_qiskit.ipynb
+examples/qaoa_pyquil.ipynb
+```
+
 ```{toctree}
    :maxdepth: 2
    :caption: API Reference