From 3b91a4fe340680ce63e0722ec3c2a11117598776 Mon Sep 17 00:00:00 2001 From: "Davide Gessa (dakk)" Date: Tue, 17 Oct 2023 16:41:44 +0200 Subject: [PATCH] doc for qtype --- TODO.md | 1 + docs/source/index.rst | 1 + docs/source/qcircuit.rst | 3 ++- docs/source/qlassf.rst | 1 + docs/source/types.rst | 8 ++++++++ 5 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 docs/source/types.rst diff --git a/TODO.md b/TODO.md index 9c3f583f..968de9ee 100644 --- 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 index 8b03c5d6..5231df63 100644 --- 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 index 67effcf2..b007f764 100644 --- 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 index 6dfe1584..9ba2a636 100644 --- 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 new file mode 100644 index 00000000..5791c9e5 --- /dev/null +++ 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: