update docs

dakk · Nov 24, 2023 · 221b0ce · 221b0ce
1 parent f0554a8
commit 221b0ce
Show file tree

Hide file tree

Showing 52 changed files with 225 additions and 1,328 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -13,7 +13,7 @@ jobs:
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
+          pip install sphinx sphinx_rtd_theme nbsphinx
           pip install sympy
       - name: Sphinx build
         run: |

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ tox
 ## Make docs
 
 ```
-pip install sphinx sphinx_rtd_theme myst_parser
+pip install sphinx sphinx_rtd_theme nbsphinx
 cd docs
 make html
 ```
diff --git a/TODO.md b/TODO.md
@@ -96,12 +96,12 @@
 
 ## Month 3:
 
-- [x] Improve exporting utilities
-- [ ] Use cases
-- [ ] Documentation
+### Week 1: (20 Nov 23)
 
+- [x] Improve exporting utilities
+- [x] Publish doc on github
+- [x] Documentation
 
-### Week 1: (20 Nov 23)
 ### Week 2: (27 Nov 23)
 ### Week 3: (4 Dec 23)
 ### Week 4: (11 Dec 23)
@@ -121,7 +121,7 @@
 
 ## Future features
 
-- [ ] Publish doc on github
+- [ ] Use cases
 - [ ] Int arithmetic expressions (/, %)
 - [ ] Parametrized qlassf
 - [ ] Lambda

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,7 @@
     "sphinx.ext.coverage",
     "sphinx.ext.napoleon",
     "sphinx_rtd_theme",
-    "myst_nb"
+    "nbsphinx",
 ]
 
 templates_path = ["_templates"]

diff --git a/docs/source/example_grover_1.ipynb b/docs/source/example_grover_1.ipynb
diff --git a/docs/source/generated/qlasskit.algorithms.groover.rst b/docs/source/generated/qlasskit.algorithms.groover.rst
diff --git a/docs/source/generated/qlasskit.algorithms.grover.rst b/docs/source/generated/qlasskit.algorithms.grover.rst
diff --git a/docs/source/generated/qlasskit.algorithms.qalgorithm.rst b/docs/source/generated/qlasskit.algorithms.qalgorithm.rst
@@ -1,4 +1,4 @@
-qlasskit.algorithms.qalgorithm
+qlasskit.algorithms.qalgorithm
 ==============================
 
 .. automodule:: qlasskit.algorithms.qalgorithm

diff --git a/docs/source/generated/qlasskit.algorithms.rst b/docs/source/generated/qlasskit.algorithms.rst
diff --git a/docs/source/generated/qlasskit.ast2ast.rst b/docs/source/generated/qlasskit.ast2ast.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.env.rst b/docs/source/generated/qlasskit.ast2logic.env.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.exceptions.rst b/docs/source/generated/qlasskit.ast2logic.exceptions.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.rst b/docs/source/generated/qlasskit.ast2logic.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.t_arguments.rst b/docs/source/generated/qlasskit.ast2logic.t_arguments.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.t_ast.rst b/docs/source/generated/qlasskit.ast2logic.t_ast.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.t_expression.rst b/docs/source/generated/qlasskit.ast2logic.t_expression.rst
diff --git a/docs/source/generated/qlasskit.ast2logic.t_statement.rst b/docs/source/generated/qlasskit.ast2logic.t_statement.rst