Add notebook support to MkDocs.

QuTech-Delft · Feb 23, 2024 · 5d1b605 · 5d1b605
1 parent 5af3ae0
commit 5d1b605
Show file tree

Hide file tree

Showing 9 changed files with 1,812 additions and 105 deletions.
diff --git a/.gitignore b/.gitignore
@@ -68,8 +68,8 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
+# MkDocs documentation
+site/
 
 # PyBuilder
 .pybuilder/

diff --git a/docs/index.md b/docs/index.md
@@ -10,10 +10,9 @@ PyPI: <https://pypi.org/project/opensquirrel/>
 
 The following documentation structure is used: [Diátaxis documentation framework](https://diataxis.fr/).
 
-1. [Tutorials](tutorials.md)
+1. [Tutorial](tutorial.ipynb)
 2. [How-To Guides](how-to-guides.md)
 3. [Reference](reference.md)
-4. [Explanation](explanation.md)
 
 ## Authors
 
@@ -25,4 +24,6 @@ The following documentation structure is used: [Diátaxis documentation framewor
 
 ## Acknowledgements
 
-_<Who made OpenSquirrel possible?\>_
+The  Quantum Inspire project
+QuTech TNO
+TU Delft
diff --git a/docs/reference.md b/docs/reference.md
@@ -3,10 +3,15 @@
 ::: opensquirrel.circuit
 ::: opensquirrel.circuit_builder
 ::: opensquirrel.circuit_matrix_calculator
+::: opensquirrel.cnot_decomposer
 ::: opensquirrel.common
 ::: opensquirrel.default_gates
+::: opensquirrel.export.quantify_scheduler_exporter
+::: opensquirrel.export_format
 ::: opensquirrel.gate_library
+::: opensquirrel.identity_filter
 ::: opensquirrel.mckay_decomposer
+::: opensquirrel.merger
 ::: opensquirrel.parsing.antlr.generated.CQasm3Lexer
 ::: opensquirrel.parsing.antlr.generated.CQasm3Listener
 ::: opensquirrel.parsing.antlr.generated.CQasm3Parser
@@ -22,4 +27,5 @@
 ::: opensquirrel.squirrel_ir
 ::: opensquirrel.utils.matrix_expander
 ::: opensquirrel.writer
+::: opensquirrel.zyz_decomposer