add quickstart.ipynb to docs

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

Hide file tree

Showing 6 changed files with 182 additions and 5 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ tox
 ## Make docs
 
 ```
-pip install sphinx sphinx_rtd_theme
+pip install sphinx sphinx_rtd_theme myst_parser
 cd docs
 make html
 ```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,6 +22,7 @@
     "sphinx.ext.coverage",
     "sphinx.ext.napoleon",
     "sphinx_rtd_theme",
+    "myst_nb"
 ]
 
 templates_path = ["_templates"]

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,16 +4,20 @@ Qlasskit
 Qlasskit is a Python library that allows quantum developers to write classical algorithms in pure 
 Python and translate them into unitary operators (gates) for use in quantum circuits.
 
-
-
 .. toctree::
    :maxdepth: 2
-
+   :caption: Qlasskit
+
+   quickstart.ipynb   
    howitworks
    supported
    algorithms
    api
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples
+
 
 Indices and tables
 ==================

diff --git a/docs/source/quickstart.ipynb b/docs/source/quickstart.ipynb
diff --git a/docs/source/supported.rst b/docs/source/supported.rst
@@ -73,6 +73,7 @@ List (fixed size)
 ^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
+   
    [a, b]
 
 

diff --git a/qlasskit/qcircuit/qcircuitwrapper.py b/qlasskit/qcircuit/qcircuitwrapper.py
@@ -86,4 +86,4 @@ def export(self, framework: SupportedFramework = "qiskit") -> Any:
         return self._qcircuit.export(mode="circuit", framework=framework)
 
     def draw(self):
-        print(self._qcircuit.draw())
+        return self._qcircuit.draw()