F doc loadfiles

Summary

For #58 (closed). Adds the missing docstrings and a short section in utilities on loadFiles.

Focus

Is the new documentation understandable and better than none?

Test Environment

make doc
firefox build/doc/html/index.html

and check the new api docs and the section in "other utilities".

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/doc/utilities.rst

@@ -35,3 +35,30 @@ behavior can be changed by initializing the ``TableImporter`` with
 :py:class:`~caosadvancedtools.datainconsistency.DataInconsistencyError` is
 raised when an empty field is encountered in a column with an non-nullable
 integer datatype.
+
+The loadfiles module and executable
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+For making files available to the LinkAhead server as File entities
+(see also the server's `file server
+<https://docs.indiscale.com/caosdb-server/specification/Fileserver.html>`_
+documentation), the LinkAhead Advanced User tools provide the
+:py:mod:`~caosadvancedtools.loadFiles` module and a
+``linkahead-loadfiles`` executable. Both operate on a path as seen by
+the LinkAhead server (i.e., a path within the Docker container in the
+typical LinkAhead Control setup) and can be further specified to
+exclude or exclude specific files. In the typical setup, where a
+directory is mounted as an *extroot* into the Docker container by
+LinkAhead control, running
+
+.. code-block:: sh
+
+   linkahead-loadfiles /opt/caosdb/mnt/extroot
+
+makes all files available. Execute
+
+.. code-block:: sh
+
+   linkahead-loadfiles --help
+
+for more information and examples.