Delete Simulation from doc

pasqal-io · Jul 11, 2023 · 03031a4 · 03031a4
1 parent 63d7a3a
commit 03031a4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/source/apidoc/simulation.rst b/docs/source/apidoc/simulation.rst
@@ -10,10 +10,10 @@ QutipEmulator
 
 :class:`QutipEmulator` is the class to simulate :class:`SequenceSamples`, that are samples of a :class:`Sequence`.
 It is possible to simulate directly a :class:`Sequence` object by using the class method 
-`SequenceSamples.from_sequence`. Since version 0.14.0, the :class:`Simulation` class is deprecated 
-for :class:`QutipEmulator`.
+``SequenceSamples.from_sequence``. Since version 0.14.0, the :class:`Simulation` class is deprecated 
+in favour of :class:`QutipEmulator`.
 
-.. automodule:: pulser_simulation.simulation
+.. autoclass:: pulser_simulation.simulation.QutipEmulator
    :members:
 
 SimConfig

diff --git a/pulser-simulation/pulser_simulation/simulation.py b/pulser-simulation/pulser_simulation/simulation.py
@@ -1156,6 +1156,8 @@ def from_sequence(
 class Simulation:
     r"""Simulation of a pulse sequence using QuTiP.
 
+    Note: This class is deprecated in favour of `QutipEmulator.from_sequence`.
+
     Args:
         sequence: An instance of a Pulser Sequence that we
             want to simulate.