Updating Documentation

[anawas]

As we seem to be working towards a Karabo version 1.0 I'm about to update the documentation.
What I did so far:

• Add documentation to many modules in karabo.util package
• Rewriting of many docstring to the Google format.

[codecov]

Codecov Report

Attention: Patch coverage is 60.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 71.19%. Comparing base (eee7ab3) to head (ba5e0e4).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
karabo/util/math_util.py	50.00%	4 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #639   +/-   ##
=======================================
  Coverage   71.19%   71.19%           
=======================================
  Files          55       55           
  Lines        5946     5947    +1     
=======================================
+ Hits         4233     4234    +1     
  Misses       1713     1713           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Lukas113]

LGTM

Two mentions:

Pydocstyle is deprecated, Ruff should be used instead (since you made changes in the pydocstyle doc). It shouldn't matter in the short-term I think? But we need to change that at some point. It should also be integrated into the CI/CD pipeline & dev-dependencies. But since the repo isn't ready to be tested in the by a docsting-tool ATM I don't think it's critical and needs to be changes in this PR.

Secondly, type-hints in docstrings are not needed if the signatures are typed (which should be the case in our repo). But I leave it up to you whether you wanna change that or not.