Skip to content

Commit 54c2c32

Browse files
committed
Update function for generating rst files
1 parent 4664639 commit 54c2c32

36 files changed

+235
-150
lines changed

docs/source/api/applications.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
tensorcircuit.applications
2+
==================================================
3+
4+
5+
.. toctree::
6+
7+
./applications_dqas.rst
8+
./applications_graphdata.rst
9+
./applications_layers.rst
10+
./applications_utils.rst
11+
./applications_vags.rst
12+
./applications_van.rst
13+
./applications_vqes.rst

docs/source/api/applications_dqas.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.dqas module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.dqas
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.graphdata module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.graphdata
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.layers module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.layers
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.utils module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.utils
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/applications_vags.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.vags module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.vags
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/applications_van.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.van module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.van
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/applications_vqes.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.applications.vqes module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.applications.vqes
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/backends.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
tensorcircuit.backends
2+
==================================================
3+
4+
5+
.. toctree::
6+
7+
./backends_backend_factory.rst
8+
./backends_jax_backend.rst
9+
./backends_numpy_backend.rst
10+
./backends_pytorch_backend.rst
11+
./backends_tensorflow_backend.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.backends.backend_factory module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.backends.backend_factory
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.backends.jax_backend module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.backends.jax_backend
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.backends.numpy_backend module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.backends.numpy_backend
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.backends.pytorch_backend module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.backends.pytorch_backend
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.backends.tensorflow_backend module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.backends.tensorflow_backend
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/channels.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.channels
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.channels module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.channels
115
:members:
126
:undoc-members:

docs/source/api/circuit.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.circuit
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.circuit module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.circuit
115
:members:
126
:undoc-members:

docs/source/api/cons.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.cons
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.cons module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.cons
115
:members:
126
:undoc-members:

docs/source/api/densitymatrix.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.densitymatrix
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.densitymatrix module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.densitymatrix
115
:members:
126
:undoc-members:

docs/source/api/densitymatrix2.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.densitymatrix2
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.densitymatrix2 module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.densitymatrix2
115
:members:
126
:undoc-members:

docs/source/api/experimental.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.experimental
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.experimental module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.experimental
115
:members:
126
:undoc-members:

docs/source/api/gates.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.gates
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.gates module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.gates
115
:members:
126
:undoc-members:

docs/source/api/interfaces.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.interfaces
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.interfaces module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.interfaces
115
:members:
126
:undoc-members:

docs/source/api/keras.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.keras
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.keras module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.keras
115
:members:
126
:undoc-members:

docs/source/api/mps_base.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.mps_base
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.mps_base module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.mps_base
115
:members:
126
:undoc-members:

docs/source/api/mpscircuit.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.mpscircuit
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.mpscircuit module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.mpscircuit
115
:members:
126
:undoc-members:

docs/source/api/quantum.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.quantum
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.quantum module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.quantum
115
:members:
126
:undoc-members:

docs/source/api/simplify.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.simplify
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.simplify module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.simplify
115
:members:
126
:undoc-members:

docs/source/api/templates.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
tensorcircuit.templates
2+
==================================================
3+
4+
5+
.. toctree::
6+
7+
./templates_blocks.rst
8+
./templates_graphs.rst
9+
./templates_measurements.rst

docs/source/api/templates_blocks.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.templates.blocks module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.templates.blocks
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/templates_graphs.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.templates.graphs module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.templates.graphs
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.templates.measurements module
2+
==================================================
3+
4+
.. automodule:: tensorcircuit.templates.measurements
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/api/utils.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.utils
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.utils module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.utils
115
:members:
126
:undoc-members:

docs/source/api/vis.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
tensorcircuit.vis
2-
==========================================
2+
==================================================
33

4-
.. toctree::
5-
:maxdepth: 4
6-
7-
8-
tensorcircuit.vis module
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
.. automodule:: tensorcircuit.vis
115
:members:
126
:undoc-members:

0 commit comments

Comments
 (0)