Refine docs

mkdocs.yml

@@ -32,14 +32,15 @@ plugins:
                     docstring_style: numpy
                     show_submodules: false
                     show_symbol_type_heading: true
+                    merge_init_into_class: true
                     show_bases: true
                     inherited_members: true
                     show_root_heading: false
                     show_root_toc_entry: false
                     show_source: true
                     heading_level: 3
                     filters:
-                    - "!^_"
+                        - "!^_"
 
 markdown_extensions:
     - attr_list

src/echosms/esmodel.py

@@ -58,7 +58,7 @@ def calculate_ts_single(self, medium_c, medium_rho, a, f,
 
         References
         ----------
-        MacLennan, D. N. (1981). The Theory of Solid Spheres as Sonar Calibration Targets
+        MacLennan, D. N. (1981). The Theory of Solid Spheres as Sonar Calibration Targets.
         Scottish Fisheries Research Report Number 22. Department of Agriculture and Fisheries
         for Scotland.
         """

src/echosms/scattermodelbase.py

@@ -17,27 +17,27 @@ class ScatterModelBase(abc.ABC):
     @abc.abstractmethod
     def __init__(self):
         """
-            Attributes
-            ----------
-            long_name : str
-                The long name of the model.
-            short_name : str
-                A short version of the model's long name, typically an ancronym.
-            analytical_type : str
-                Whether the model implements an ``exact`` or an ``approximate`` model.
-            boundary_types : list[str]
-                The types of boundary conditions that the model provides, e.g., 'fixed rigid',
-                'pressure release', 'fluid filled'
-            shapes : list[str]
-                The target shapes that the model can represent.
-            max_ka : float
-                An approximate maximum ka value that will result in accurate target strength results. Note
-                that ka is often not the only parameter that determines the accuracy of the model (e.g.,
-                aspect ratio and incident angle can also affect the accuracy).
-            no_expand_parameters : list[str]
-                The model parameters that are not expanded into Pandas DataFrame columns or
-                Xarray DataArray coordinates. They will instead end up as a dict in the DataFrame or
-                DataArray `attrs` attribute.
+        Attributes
+        ----------
+        long_name : str
+            The long name of the model.
+        short_name : str
+            A short version of the model's long name, typically an ancronym.
+        analytical_type : str
+            Whether the model implements an ``exact`` or an ``approximate`` model.
+        boundary_types : list[str]
+            The types of boundary conditions that the model provides, e.g., 'fixed rigid',
+            'pressure release', 'fluid filled'
+        shapes : list[str]
+            The target shapes that the model can represent.
+        max_ka : float
+            An approximate maximum ka value that will result in accurate target strength results. Note
+            that ka is often not the only parameter that determines the accuracy of the model (e.g.,
+            aspect ratio and incident angle can also affect the accuracy).
+        no_expand_parameters : list[str]
+            The model parameters that are not expanded into Pandas DataFrame columns or
+            Xarray DataArray coordinates. They will instead end up as a dict in the DataFrame or
+            DataArray `attrs` attribute.
         """
         self.long_name = ''
         self.short_name = ''