show in docs

PennyLaneAI · May 13, 2024 · d806fa3 · d806fa3
1 parent 65e158f
commit d806fa3
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/doc/code/qml_noise.rst b/doc/code/qml_noise.rst
@@ -0,0 +1,11 @@
+Overview
+--------
+
+This module contains functions and classes for creating and manipulating noise models.
+
+.. currentmodule:: pennylane.noise
+
+.. automodapi:: pennylane.noise
+    :no-heading:
+    :no-main-docstr:
+    :no-inherited-members:
diff --git a/doc/index.rst b/doc/index.rst
@@ -201,6 +201,7 @@ PennyLane is **free** and **open source**, released under the Apache License, Ve
    code/qml_kernels
    code/qml_logging
    code/qml_math
+   code/qml_noise
    code/qml_numpy
    code/qml_ops_op_math
    code/qml_pauli

diff --git a/pennylane/noise/__init__.py b/pennylane/noise/__init__.py
@@ -11,10 +11,19 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-r"""
+"""This module contains the functionality to work with noise in PennyLane.
+
 .. currentmodule:: pennylane
 
-This module contains the functionality to work with noise in PennyLane.
+.. autosummary::
+    :toctree: api
+
+    op_eq
+    op_in
+    partial_wires
+    wires_eq
+    wires_in
+
 """
 
 from .conditionals import NoiseConditional, AndConditional, OrConditional