create a separate tags page

unitaryfund · Aug 24, 2024 · 4dcf711 · 4dcf711
1 parent 65a9419
commit 4dcf711
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 12 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -111,6 +111,24 @@ def setup(app):
 tags_page_header = "Pages with this tag: "
 tags_index_head = "Tags in the documentation tutorials: "
 tags_extension = ["md"]
+tags_badge_colors = {
+    "zne": "primary",
+    "rem": "primary",
+    "shadows": "primary",
+    "cdr": "primary",
+    "pec": "primary",
+    "ddd": "primary",
+    "calibration": "primary",
+    "cirq": "secondary",
+    "bqskit": "secondary",
+    "braket": "secondary",
+    "pennylane": "secondary",
+    "qiskit": "secondary",
+    "stim": "secondary",
+    "qrack": "secondary",
+    "qibo": "secondary",
+    "ionq": "secondary",
+}
 
 # hide primary sidebar from the following pages
 html_sidebars = {"apidoc": [], "changelog": [], "bibliography": []}

diff --git a/docs/source/examples/examples.md b/docs/source/examples/examples.md
@@ -1,6 +1,8 @@
 # Examples
 
-Below you can find a gallery of tutorials applying Zero Noise Extrapolation (ZNE), Probabilistic Error Cancellation (PEC), Clifford Data Regression (CDR), and Digital Dynamical Decoupling (DDD) with Mitiq:
+Below you can find a gallery of tutorials applying Zero Noise Extrapolation (ZNE), Probabilistic Error Cancellation (PEC), Clifford Data Regression (CDR), and Digital Dynamical Decoupling (DDD), etc. with Mitiq.
+
+You can also search for a specific example by clicking through the tags available [here.](tags.md)
 
 ```{nbgallery}
 ZNE Calibration with Qiskit <calibration-tutorial.md>
@@ -37,13 +39,4 @@ GGI Summer School ZNE Hands-On Tutorial <ggi_summer_school_unsolved.md>
 Composing techniques: REM + ZNE <combine_rem_zne.md>
 Composing techniques: DDD + ZNE <combine_ddd_zne.md>
 The Mitiq paper code <mitiq-paper/mitiq-paper-codeblocks.md>
-```
-
-You can also search for a specific example by clicking on one of the tags below:
-
-```{toctree}
----
-maxdepth: 2
----
-../../_tags/tagsindex.md
 ```
diff --git a/docs/source/examples/pyquil_demo.ipynb b/docs/source/examples/pyquil_demo.ipynb
diff --git a/docs/source/examples/tags.md b/docs/source/examples/tags.md
@@ -0,0 +1,8 @@
+# Tags in Examples
+
+```{toctree}
+---
+maxdepth: 2
+---
+../../_tags/tagsindex.md
+```
diff --git a/docs/source/examples/vqe-pyquil-demo.ipynb b/docs/source/examples/vqe-pyquil-demo.ipynb
@@ -33,6 +33,15 @@
     "## Defining the quantum system using pyQuil"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "b3340e15",
+   "metadata": {},
+   "source": [
+    "```{tags} zne\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -7,6 +7,7 @@ hidden: true
 ---
 guide/guide.md
 examples/examples.md
+examples/tags.md
 apidoc.md
 toc_contributing.md
 changelog.md