doc for qtype

dakk · Oct 17, 2023 · 3b91a4f · 3b91a4f
1 parent cfa6e21
commit 3b91a4f
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/TODO.md b/TODO.md
@@ -47,6 +47,7 @@
 - [x] Fix code structure and typing location
 
 ### Week 4: (16 Oct 23)
+- [x] Extensible type system
 - [ ] Publish doc
 - [ ] Int arithmetic: +
 - [ ] Function call

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -21,6 +21,7 @@ Python and translate them into unitary operators (gates) for use in quantum circ
    howitworks
    supported
    qlassf
+   types
    qcircuit
 
 

diff --git a/docs/source/qcircuit.rst b/docs/source/qcircuit.rst
@@ -3,6 +3,7 @@ QCircuit
 
 QCircuit represents a quantum circuit inside the Qlasskit library.
 
-.. automodule:: qlasskit.qcircuit
+.. autoclass:: qlasskit.qcircuit.QCircuit
    :members:
+   :undoc-members:
 
diff --git a/docs/source/qlassf.rst b/docs/source/qlassf.rst
@@ -5,3 +5,4 @@ QlassF is the key component of the qlasskit library.
 
 .. automodule:: qlasskit.qlassf
    :members:
+   :undoc-members:
diff --git a/docs/source/types.rst b/docs/source/types.rst
@@ -0,0 +1,8 @@
+Types
+====================================
+
+All supported types by the qlasskit library are inherit from the base `Qtype`.
+
+.. autoclass:: qlasskit.Qtype
+   :members:
+   :undoc-members: