Update docs

[RiesBen]

Adding docs:

• api reference
• top level text
• Tutorial for planning and visualizing networks

[pep8speaks]

Hello @RiesBen! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file src/konnektor/network_planners/generators/clustered_network_generator.py:

Line 168:80: E501 line too long (81 > 79 characters)

• In the file src/konnektor/network_tools/network_handling/__init__.py:

Line 6:54: W292 no newline at end of file

• In the file src/konnektor/network_tools/network_handling/concatenate.py:

Line 8:80: E501 line too long (85 > 79 characters)

• In the file src/konnektor/tests/network_tools/test_merge.py:

Line 2:80: E501 line too long (93 > 79 characters)

Comment last updated at 2024-05-12 17:15:50 UTC

[codecov]

Codecov Report

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

Project coverage is 90.31%. Comparing base (c247e66) to head (e0251e2).
Report is 4 commits behind head on main.

Files	Patch %	Lines
...c/konnektor/network_tools/network_handling/misc.py	0.00%	3 Missing ⚠️
...planners/generators/clustered_network_generator.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #47      +/-   ##
==========================================
- Coverage   90.56%   90.31%   -0.25%     
==========================================
  Files          42       44       +2     
  Lines        1166     1167       +1     
==========================================
- Hits         1056     1054       -2     
- Misses        110      113       +3     

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