Github related improvements

[veenstrajelmer]

Documentation/license:

• action now fails when nothing to commit, fix this
• github pages
• documentation like xugrid (also download source/notebook is available) >> From pdoc to mkdocs (to sphinx) #354
• add downloads badge: https://github.com/squidfunk/mkdocs-material/blob/master/README.md
• On the proposed ccompiler.has_flag method pypa/setuptools#771
• use sphinx instead of makedocs (like ddlpy)
• fix code quality badge (& in url goes wrong): Including a README.md with links that contain &s, "translates them" to & omnilib/sphinx-mdinclude#19 >> Certain characters in inline code incorrectly parsed (e.g., &) lepture/mistune#372 and Certain characters in markdown code incorrectly parsed (e.g., &) lepture/mistune#394
• update docstrings in all exposed functions in modules section (remove TODO from docstrings)
• check licenses of MeshKernelPy/Meshkernel, xarray, xugrid etc. Compliant with dfm_tools license?
• fix python code coloring in embedded ipynb

Code style/quality:

• replace readme badge with overall (?): https://sonarcloud.io/summary/overall?id=Deltares_dfm_tools
• style guide: https://www.python.org/dev/peps/pep-0008/
• isort/black: https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
• argument type checking (pydantic?)
• improve sonarcloud code quality and fix code issues: https://sonarcloud.io/project/issues?resolved=false&id=Deltares_dfm_tools
• solve flake8 messages in pytest workflows
• introduce types for essential variables: https://docs.python.org/3/library/typing.html (and update docstring)
• properly deprecate deprecated functions
• pre-commit-config: https://github.com/savente93/automation-demo

Create issues:

• convert TODO from dfm_tools functions and example scripts into Github issues: https://sonarcloud.io/project/issues?resolved=false&severities=INFO&id=Deltares_dfm_tools (216 on 15-5-2024)
• convert example scripts into Github issues, unittests and notebooks

Testbank:

• enable pytest via github actions
• fix pytest by temporary ignoring testcases marked with requiresdata (reduces codecov but that is ok)
• add codecov badge (fix percentage)
• Bootstrap is deprecated, remove from docs? pypa/setuptools#336
• simplify testbank with matrix #683
• pytest ignore UserWarning via pyproject.toml
• make cds/cmems testcases work on github by setting env vars
• add windows and macos testbanks
• phase out requireslocaldata tests by making testdata available (and avoiding p-drive links). Now we have opendap download. Maybe use HYDROLIB-data repos instead (or xugrid cached downloads)? Maybe use dsctestbench data on repos, how to authenticate on github?
• increase test coverage: https://app.codecov.io/gh/deltares/dfm_tools?displayType=list