add layers to docs

mit-han-lab · Oct 15, 2023 · e815341 · e815341
1 parent 8f40ff3
commit e815341
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
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/index.rst b/docs/source/index.rst
@@ -5,6 +5,7 @@
    api_torchquantum
    api_functional
    api_operators
+   api_layers
 
 .. toctree::
    :maxdepth: 1