docs: sphinx documentation tools module closes #9

docs/source/module_tools.md

@@ -0,0 +1,53 @@
+# Module `tools`
+
+```{eval-rst}
+.. automodule:: mdsanima_dev.utils.tools
+```
+
+## Function `read_file`
+
+```{eval-rst}
+.. autofunction:: mdsanima_dev.utils.tools.read_file
+```
+
+## Function `append_file`
+
+```{eval-rst}
+.. autofunction:: mdsanima_dev.utils.tools.append_file
+```
+
+## Function `get_response_json`
+
+```{eval-rst}
+.. autofunction:: mdsanima_dev.utils.tools.get_response_json
+```
+
+## Function `machine`
+
+```{eval-rst}
+.. autofunction:: mdsanima_dev.utils.tools.machine
+```
+
+## Class `progress`
+
+```{eval-rst}
+.. autoclass:: mdsanima_dev.utils.tools.progress
+```
+
+### Method ``__init__()``
+
+```{eval-rst}
+.. automethod:: mdsanima_dev.utils.tools.progress.__init__
+```
+
+### Method ``progress_conf()``
+
+```{eval-rst}
+.. automethod:: mdsanima_dev.utils.tools.progress.progress_conf
+```
+
+### Method ``progress_bar()``
+
+```{eval-rst}
+.. automethod:: mdsanima_dev.utils.tools.progress.progress_bar
+```