Merge pull request #205 from GenericP3rson/docs_update

Updating the Documentation
mit-han-lab · Oct 20, 2023 · 2bffd4f · 2bffd4f
2 parents d2d8b79 + 09a9afe
commit 2bffd4f
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/docs/source/api_layers.rst b/docs/source/api_layers.rst
@@ -0,0 +1,29 @@
+torchquantum.layers
+======================
+
+.. currentmodule:: torchquantum.layer
+
+Layers
+---------
+.. autosummary::
+    :toctree: generated
+    :template: classtemplate_controlflow.rst
+
+
+    QuantumModuleFromOps
+    TrainableOpAll
+    ClassicalInOpAll
+    FixedOpAll
+    TwoQAll
+    RandomLayer
+    RandomLayerAllTypes
+    Op1QAllLayer
+    RandomOp1All
+    Op2QAllLayer
+    Op2QButterflyLayer
+    Op2QDenseLayer
+    CXLayer
+    CXCXCXLayer
+    SWAPSWAPLayer
+    RXYZCXLayer0
+    QFTLayer
diff --git a/docs/source/api_operators.rst b/docs/source/api_operators.rst
@@ -1,7 +1,7 @@
 torchquantum.operators
 ======================
 
-.. currentmodule:: torchquantum.operators
+.. currentmodule:: torchquantum.operator
 
 Classes
 ---------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,6 +5,7 @@
    api_torchquantum
    api_functional
    api_operators
+   api_layers
 
 .. toctree::
    :maxdepth: 1