include new modules in the doc

carnisj · Mar 18, 2022 · 7a6607a · 7a6607a
1 parent cd0db44
commit 7a6607a
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/bcdi/utils/parameters.py b/bcdi/utils/parameters.py
@@ -7,9 +7,10 @@
 #         Jerome Carnis, carnis_jerome@yahoo.fr
 
 """
-Definition of the correct parameters for the config files.
+Validation of configuration parameters.
 
-Parameter validation is performed over the excepted parameters.
+The validation is performed only on the expected parameters. Other parameters are simply
+discarded.
 """
 from numbers import Number, Real
 import numpy as np

diff --git a/bcdi/utils/parser.py b/bcdi/utils/parser.py
@@ -164,7 +164,7 @@ class ConfigParser:
     file. Some validation is also realized in the class.
 
     :param file_path: path of the configuration file that contains
-    the arguments, str.
+     the arguments, str.
     :param command_line_args: an optional dictionary of command-line arguments
     """
 

diff --git a/doc/modules/utils/index.rst b/doc/modules/utils/index.rst
@@ -30,6 +30,39 @@ API Reference
 .. automodule:: bcdi.utils.image_registration
    :members:
 
+io_helper
+^^^^^^^^^
+
+Class and decorators related to the safe opening of files.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.io_helper
+   :members:
+
+parameters
+^^^^^^^^^^
+
+Function related to the validation of configuration parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parameters
+   :members:
+
+parser
+^^^^^^
+
+Class and functions related to loading of the config file and command line parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parser
+   :members:
+
 validation
 ^^^^^^^^^^