Fix docs display

Fix missing docstrings

Author: Rud356

config_framework/loaders/composite.py

@@ -21,6 +21,13 @@ def load(
         cls, *loaders: AbstractLoader,
         defaults: Optional[MutableMapping[str, Any]] = None
     ):
+        """
+        Initializes composite loader.
+
+        :param loaders: any number of different config sources that can be used for providing configuration.
+        :param defaults: default values.
+        :return: instance of composite loader.
+        """
         return cls(
             data=ChainMap(*loaders),
             defaults=defaults or {},

config_framework/loaders/dict.py

@@ -9,11 +9,18 @@ def load(
         cls, data: MutableMapping[str, Any],
         defaults: Optional[MutableMapping[str, Any]] = None
     ):
+        """
+        Wrapper for dicts usage as config source.
+
+        :param data: argument expects dictionary that will be used as source.
+        :param defaults: default values.
+        :return: instance of dict loader.
+        """
         return cls(data=data, defaults=defaults or {})
 
     def dump(self, include_defaults: bool = False) -> None:
         """
-        This method doesn't changes anything since dict is updated whenever
+        This method doesn't change anything since dict is updated whenever
         values are changed.
 
         :param include_defaults: specifies if

config_framework/loaders/env.py

@@ -7,11 +7,17 @@
 class Environment(AbstractLoader):
     @classmethod
     def load(cls, defaults: Optional[MutableMapping[str, Any]] = None):
+        """
+        Loads data from environment.
+
+        :param defaults: default values.
+        :return: instance of env loader.
+        """
         return cls(data=dict(environ), defaults=defaults or {})
 
     def dump(self, include_defaults: bool = False) -> None:
         """
-        This method doesn't changes env variables at all
+        This method doesn't change env variables at all
         because not many types, convert properly into string env variable
         and can be loaded back.
 

config_framework/loaders/json.py

@@ -35,6 +35,16 @@ def load(
         json_loader=json.load,
         json_dumper=partial(json.dump, ensure_ascii=False, indent=4),
     ):
+        """
+        Loads json file from path into loader.
+
+        :param path: where file with json is located.
+        :param defaults: default values.
+        :param encoding: which encoding does config file has (defaults to utf-8).
+        :param json_loader: function that loads json file.
+        :param json_dumper: function that dumps to json file.
+        :return: instance of json loader.
+        """
         with open(path, encoding=encoding) as data_f:
             data = json_loader(data_f)
 

config_framework/loaders/json_string.py

@@ -30,6 +30,16 @@ def load(
         json_loader=json.loads,
         json_dumper=partial(json.dumps, ensure_ascii=False, indent=4),
     ):
+        """
+        Loads json file from path into loader.
+
+        :param data_string: string with valid json formatted text.
+        :param defaults: default values.
+        :param encoding: which encoding does config file has (defaults to utf-8).
+        :param json_loader: function that loads json from string.
+        :param json_dumper: function that dumps to json string.
+        :return: instance of json string loader.
+        """
         data = json_loader(data_string)
 
         return cls(
@@ -39,7 +49,7 @@ def load(
 
     def dump(self, include_defaults: bool = False) -> None:
         """
-        This method doesn't changes anything at all
+        This method doesn't change anything at all
         because strings are unchangeable.
 
         :param include_defaults: specifies if

config_framework/loaders/toml_full_features.py

@@ -37,10 +37,8 @@ def load(
 
         :param path: path that is used to load config.
         :param defaults: default values.
-        :param loader_kwargs: used for specifying parameters, according to
-        tomls' documentation of `toml.load` function.
-        :param dumper_kwargs: used for specifying parameters, according to
-        tomls' documentation of `toml.dump` function.
+        :param loader_kwargs: used for specifying parameters, according to toml documentation of `toml.load` function.
+        :param dumper_kwargs: used for specifying parameters, according to toml documentation of `toml.dump` function.
         :param encoding: which encoding should be used for a file.
         :return: instance of TomlReadOnly class.
         """

config_framework/loaders/toml_read_only.py

@@ -40,10 +40,12 @@ def load(
 
         :param path: path that is used to load config.
         :param defaults: default values.
-        :param loader_kwargs: used for specifying parameters, according to
-        tomllibs' documentation of `tomllib.load` function.
+        :param loader_kwargs: used for specifying parameters, according to tomllib documentation of `tomllib.load`
+            function.
+
         :param dumper_kwargs: not used.
         :param encoding: which encoding should be used for a file.
+
         :return: instance of TomlReadOnly class.
         """
         with open(path, encoding=encoding, mode="b") as data_f:

config_framework/loaders/yaml.py

@@ -43,6 +43,16 @@ def load(
         yaml_loader=partial(yaml.load, Loader=Loader),
         yaml_dumper=partial(yaml.dump, Dumper=Dumper),
     ):
+        """
+        Loads yaml from file.
+
+        :param path: where is yaml file to load data from.
+        :param defaults: default values for config.
+        :param encoding: which encoding does config file has (defaults to utf-8).
+        :param yaml_loader: function that is used for loading data from file.
+        :param yaml_dumper: function that is used for saving data to file.
+        :return: instance of yaml loader.
+        """
         with open(path, encoding=encoding) as data_f:
             data = yaml_loader(data_f)
 

docs/source/config_framework.loaders.rst

@@ -40,6 +40,18 @@ Submodules
    :show-inheritance:
 
 
+.. automodule:: config_framework.loaders.toml_full_features
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: config_framework.loaders.toml_read_only
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 .. automodule:: config_framework.loaders.yaml
    :members:
    :undoc-members:

docs/source/index.rst

@@ -92,6 +92,7 @@ Example of usage
     # create an instance of like this: ConfigSample(frozen=False)
     # But right now it will raise NotImplementedError
     config.some_value = "random"
+
 See examples with explanation `here <https://github.com/Rud356/ConfigFramework/blob/master/examples/>`_
 
 Supported config formats