DOC: improve monte Carlo documentation files

docs/reference/classes/monte_carlo/index.rst

@@ -0,0 +1,9 @@
+Monte Carlo Analysis
+====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   monte_carlo
+   Stochastic models <stochastic_models/index>

docs/reference/classes/monte_carlo/monte_carlo.rst

@@ -0,0 +1,5 @@
+Monte Carlo Class
+-----------------
+
+.. autoclass:: rocketpy.simulation.MonteCarlo
+    :members:

docs/reference/classes/monte_carlo/stochastic_models/index.rst

@@ -0,0 +1,20 @@
+Stochastic Models
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   stochastic_model
+   stochastic_environment
+   stochastic_motor_model
+   stochastic_solid_motor
+   stochastic_generic_motor
+   stochastic_nose_cone
+   stochastic_trapezoidal_fins
+   stochastic_elliptical_fins
+   stochastic_tail
+   stochastic_rail_buttons
+   stochastic_rocket
+   stochastic_parachute
+   stochastic_flight

docs/reference/classes/monte_carlo/stochastic_models/stochastic_elliptical_fins.rst

@@ -0,0 +1,5 @@
+Stochastic Elliptical Fins
+--------------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticEllipticalFins
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_environment.rst

@@ -0,0 +1,5 @@
+Stochastic Environment
+----------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticEnvironment
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_flight.rst

@@ -0,0 +1,5 @@
+Stochastic Flight
+-----------------
+
+.. autoclass:: rocketpy.stochastic.StochasticFlight
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_generic_motor.rst

@@ -0,0 +1,5 @@
+Stochastic Generic Motor
+------------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticGenericMotor
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_model.rst

@@ -0,0 +1,7 @@
+.. _stochastic_model:
+
+Stochastic Model
+-----------------
+
+.. autoclass:: rocketpy.stochastic.StochasticModel
+    :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_motor_model.rst

@@ -0,0 +1,5 @@
+Stochastic Motor Model
+----------------------
+
+.. autoclass:: rocketpy.stochastic.stochastic_motor_model.StochasticMotorModel
+    :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_nose_cone.rst

@@ -0,0 +1,5 @@
+Stochastic Nose Cone
+--------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticNoseCone
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_parachute.rst

@@ -0,0 +1,5 @@
+Stochastic Parachute
+--------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticParachute
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_rail_buttons.rst

@@ -0,0 +1,5 @@
+Stochastic Rail Buttons
+-----------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticRailButtons
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_rocket.rst

@@ -0,0 +1,5 @@
+Stochastic Rocket
+-----------------
+
+.. autoclass:: rocketpy.stochastic.StochasticRocket
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_solid_motor.rst

@@ -0,0 +1,5 @@
+Stochastic Solid Motor
+----------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticSolidMotor
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_tail.rst

@@ -0,0 +1,5 @@
+Stochastic Tail
+---------------
+
+.. autoclass:: rocketpy.stochastic.StochasticTail
+   :members:

docs/reference/classes/monte_carlo/stochastic_models/stochastic_trapezoidal_fins.rst

@@ -0,0 +1,5 @@
+Stochastic Trapezoidal Fins
+---------------------------
+
+.. autoclass:: rocketpy.stochastic.StochasticTrapezoidalFins
+    :members:

docs/reference/index.rst

@@ -17,6 +17,7 @@ This reference manual details functions, modules, methods and attributes include
    classes/Flight
    Utilities <classes/utils/index>
    classes/EnvironmentAnalysis
+   Monte Carlo Analysis <classes/monte_carlo/index> 
 
 .. toctree::
    :maxdepth: 2

rocketpy/plots/monte_carlo_plots.py

@@ -39,8 +39,9 @@ def ellipses(
             The limits of the y axis. The default is (-3000, 3000).
         save : bool
             Whether save the output into a file or not. The default is False.
-            If True, the .show() method won't be called, and the image will be
-            saved with the same name as filename attribute, using a .png format.
+            If True, the image will not be displayed, and the .savefig() method
+            will be called. If False, the image will be displayed, and the
+            .show() method will be called.
 
         Returns
         -------

rocketpy/stochastic/stochastic_aero_surfaces.py

@@ -15,6 +15,10 @@ class is used to receive a NoseCone object and information about the
     dispersion of its parameters and generate a random nose cone object based
     on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : NoseCone
@@ -51,8 +55,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------
@@ -120,6 +123,10 @@ class StochasticTrapezoidalFins(StochasticModel):
     the dispersion of its parameters and generate a random trapezoidal fins
     object based on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : TrapezoidalFins
@@ -171,8 +178,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------
@@ -251,6 +257,10 @@ class StochasticEllipticalFins(StochasticModel):
     the dispersion of its parameters and generate a random elliptical fins
     object based on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : EllipticalFins
@@ -290,8 +300,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------
@@ -356,6 +365,10 @@ class StochasticTail(StochasticModel):
     parameters and generate a random tail object based on the provided
     information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : Tail
@@ -388,8 +401,7 @@ def __init__(
 
         See Also
         --------
-        TODO: This should link to somewhere that explains how inputs works in
-        stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------
@@ -443,6 +455,10 @@ class is used to receive a RailButtons object and information about the
     dispersion of its parameters and generate a random rail buttons object based
     on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : RailButtons
@@ -470,8 +486,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_environment.py

@@ -7,6 +7,10 @@ class is used to receive a Environment object and information about the
     dispersion of its parameters and generate a random environment object based
     on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : Environment
@@ -53,8 +57,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_flight.py

@@ -9,6 +9,10 @@ class is used to receive a Flight object and information about the
     dispersion of its parameters and generate a random flight object based on
     the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     flight : Flight
@@ -44,8 +48,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_generic_motor.py

@@ -9,6 +9,10 @@ class StochasticGenericMotor(StochasticMotorModel):
     the dispersion of its parameters and generate a random generic motor object
     based on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : GenericMotor
@@ -96,8 +100,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic Models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_motor_model.py

@@ -4,6 +4,10 @@
 class StochasticMotorModel(StochasticModel):
     """Stochastic Motor Model class that inherits from StochasticModel. This
     class is used to standardize the input of the motor stochastic model.
+
+    See Also
+    --------
+    :ref:`stochastic_model`
     """
 
     def __init__(self, object, **kwargs):

rocketpy/stochastic/stochastic_parachute.py

@@ -9,6 +9,10 @@ class is used to receive a Parachute object and information about the
     dispersion of its parameters and generate a random parachute object based
     on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : Parachute
@@ -46,8 +50,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic Models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_rocket.py

@@ -34,6 +34,10 @@ class is used to receive a Rocket object and information about the
     dispersion of its parameters and generate a random rocket object based on
     the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : Rocket
@@ -113,8 +117,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------

rocketpy/stochastic/stochastic_solid_motor.py

@@ -9,6 +9,10 @@ class is used to receive a SolidMotor object and information about the
     dispersion of its parameters and generate a random solid motor object based
     on the provided information.
 
+    See Also
+    --------
+    :ref:`stochastic_model`
+
     Attributes
     ----------
     object : SolidMotor
@@ -110,8 +114,7 @@ def __init__(
 
         See Also
         --------
-        This should link to somewhere that explains how inputs works in
-        Stochastic Models.
+        :ref:`stochastic_model`
 
         Parameters
         ----------