Updated docs API reference (#99)

* docs: Added docstrings to file_io module

* docs: added class docstrings to ModelFileRegistry.

* docs: added method docstring to CatalogRepository.filter_catalog

Author: pabloitu

docs/reference/api_reference.rst

@@ -150,22 +150,27 @@ A small wrapper for ``pyCSEP`` readers
 .. autosummary::
    :nosignatures:
 
+    CatalogParser
     CatalogParser.ascii
     CatalogParser.json
 
+    CatalogSerializer
     CatalogSerializer.ascii
     CatalogSerializer.json
 
+    GriddedForecastParsers
     GriddedForecastParsers.dat
     GriddedForecastParsers.xml
     GriddedForecastParsers.quadtree
     GriddedForecastParsers.csv
     GriddedForecastParsers.hdf5
 
+    CatalogForecastParsers
     CatalogForecastParsers.csv
     CatalogForecastParsers.load_hermes_catalog
 
     HDF5Serializer.grid2hdf5
+    check_format
     serialize
 
 

floatcsep/infrastructure/registries.py

@@ -167,6 +167,14 @@ def factory(
 
 
 class ModelFileRegistry(ModelRegistry, FilepathMixin):
+    """
+    The class is responsible to handle the keys (in this case filepaths) to access model objects
+    such as forecasts, input catalogs or argument/parameter files. These keys are used mainly by
+    :class:`floatcsep.infrastructure.repositories.ForecastRepository` or
+    :class:`floatcsep.infrastructure.repositories.CatalogRepository`.
+
+    """
+
     def __init__(
         self,
         model_name: str,

floatcsep/infrastructure/repositories.py

@@ -238,7 +238,22 @@ def filter_catalog(
         max_depth=None,
         region=None,
     ) -> CSEPCatalog:
+        """
+        Wrapper for pyCSEP catalog filters, to constrain a catalog to a given time and magnitude
+        range, as well to a spatial region.
+
+        Args:
+            start_date (datetime.datetime): Initial datetime
+            end_date (datetime.datetime): Final datetime
+            min_mag (float): Minimum magnitude to filter
+            max_mag (float): Maximum magnitude to filter
+            min_depth (float): Minimum depth to filter (positive downwards from surface)
+            max_depth (float): Maximum depth to filter (positive downwards from surface)
+            region (csep.core.regions.CartesianGrid2D): Spatial domain to filter
 
+        Returns:
+            Filtered catalog
+        """
         filters = []
         if start_date:
             filters.append(