fix documentation warnings

upb-lea · Feb 6, 2024 · 9d9685a · 9d9685a
1 parent 46a8871
commit 9d9685a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 19 deletions.
diff --git a/documentation/source/intro.rst b/documentation/source/intro.rst
@@ -17,42 +17,42 @@ The ``MagneticComponent`` class
 ---------------------------------------
 .. currentmodule:: femmt.MagneticComponent
 
-.. autoclass:: MagneticComponent
-   :members: set_core, set_air_gaps, set_insulation, set_stray_path, set_winding_window, create_model, single_simulation, excitation_sweep, mesh, thermal_simulation, femm_reference, femm_thermal_validation
+.. autoclass:: femmt.MagneticComponent
+   :members: set_core, set_air_gaps, set_insulation, set_stray_path, create_model, single_simulation, excitation_sweep, mesh, thermal_simulation, femm_reference, femm_thermal_validation
    :special-members: __init__
 
 The ``Core`` class
 --------------------------------------
-.. autoclass:: femmt.Model.Core
+.. autoclass:: femmt.Core
     :special-members: __init__
 
 The ``AirGaps`` class
 --------------------------------------
-.. autoclass:: femmt.Model.AirGaps
+.. autoclass:: femmt.AirGaps
     :members: add_air_gap
     :special-members: __init__
 
 The ``Insulation`` class
 --------------------------------------
-.. autoclass:: femmt.Model.Insulation
+.. autoclass:: femmt.Insulation
     :members: add_winding_insulations, add_core_insulations
     :special-members: __init__
 
 The ``Conductor`` class
 --------------------------------------
-.. autoclass:: femmt.Model.Conductor
+.. autoclass:: femmt.Conductor
     :members: set_rectangular_conductor, set_solid_round_conductor, set_litz_round_conductor
     :special-members: __init__
 
 The ``WindingWindow`` class
 --------------------------------------
-.. autoclass:: femmt.Model.WindingWindow
+.. autoclass:: femmt.WindingWindow
     :members: split_window, combine_vww
     :special-members: __init__
 
 The ``VirtualWindingWindow`` class
 --------------------------------------
-.. autoclass:: femmt.Model.VirtualWindingWindow
+.. autoclass:: femmt.VirtualWindingWindow
     :members: set_winding, set_interleaved_winding
     :special-members: __init__
 
@@ -76,13 +76,12 @@ The ``LogParser`` class
 
 ``Enumerations``
 ---------------------------------
-.. automodule:: femmt.Enumerations
-    :members:
-    :undoc-members:
+.. currentmodule:: femmt
+.. autoclass:: femmt.enumerations
 
 Helper functions
 ---------------------------------
-.. automodule:: femmt.Functions
-    :members: core_database, litz_database, wire_material_database
+.. automodule:: femmt.functions
+    :members:
 
 .. include:: developer_notes.rst
diff --git a/femmt/functions.py b/femmt/functions.py
@@ -1232,13 +1232,13 @@ def find_result_log_file(result_log_folder: str, keyword_list: list, value_min_m
 
     :param result_log_folder: filepath to result-log folder
     :type result_log_folder: str
-    :param keyword_list: list with hirarchical keywords for dictionary structure, e.g. ["simulation_settings", "core",
-        "core_inner_diameter"]
+    :param keyword_list: list with hirarchical keywords for dictionary structure, e.g. ["simulation_settings", "core", "core_inner_diameter"]
     :type keyword_list: list
     :param value_min_max: value to check for
     :type value_min_max: list
 
     :Example:
+
     Check for files with a core inner diameter smaller equal than 0.02 m.
     >>> import femmt as fmt
     >>> fmt.find_result_log_file("/home/filepath/fem_simulation_data", ["simulation_settings", "core",
@@ -1538,6 +1538,7 @@ def visualize_mean_mutual_inductances(inductance_matrix: np.array, silent: bool)
     :type inductance_matrix: np.array
     :param silent: True for no output
     :type silent: bool
+
     e.g.  M_12 = M_21 = k_12 * (L_11 * L_22) ** 0.5
     """
     string_to_print = ""
@@ -1563,6 +1564,7 @@ def visualize_mutual_inductances(self_inductances: List, coupling_factors: List,
     :type coupling_factors: List
     :param silent: True for no output
     :type silent: bool
+
     e.g. M_12 = L_11 * K_21  !=   M_21 = L_22 * K_12   (ideally, they are the same)
     """
     string_to_print = ""
@@ -1624,7 +1626,6 @@ def calculate_quadrature_integral(timesteps: List[float], data: List[float]) ->
     :type timesteps: List[float]
     :param data: List of data corresponding to each timestep.
     :type data: List[float]
-    Returns:
     :return: The calculated integral.
     :rtype: float
     """
@@ -1639,7 +1640,6 @@ def calculate_squared_quadrature_integral(timesteps: List[float], data: List[flo
     :type timesteps: List[float]
     :param data: List of data corresponding to each timestep.
     :type data: List[float]
-    Returns:
     :return: The calculated integral.
     :rtype: float
     """

diff --git a/femmt/model.py b/femmt/model.py
@@ -628,8 +628,8 @@ def add_winding_insulations(self, inner_winding_insulation: List[List[float]]):
 
         Insulation between virtual winding windows is not always needed.
         :param inner_winding_insulation: List of floats which represent the insulations between turns of the same winding. This does not correspond to
-            the order conductors are added to the winding! Instead, the winding number is important. The conductors are sorted by ascending winding number.
-            The lowest winding number therefore is combined with index 0. The second lowest with index 1 and so on.
+        the order conductors are added to the winding! Instead, the winding number is important. The conductors are sorted by ascending winding number.
+        The lowest winding number therefore is combined with index 0. The second lowest with index 1 and so on.
         :type inner_winding_insulation: List[List[float]]
         """
         if inner_winding_insulation is [[]]: