Created plugin documentation

[ThunderKey]

I've found a way to create the entire documentation of the code, but I'm not too keen on the format of this.

[codecov[bot]]

Codecov Report

Merging #14 into master will increase coverage by 4.38%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #14      +/-   ##
==========================================
+ Coverage   91.02%   95.41%   +4.38%     
==========================================
  Files          16       30      +14     
  Lines         468      981     +513     
  Branches       28       53      +25     
==========================================
+ Hits          426      936     +510     
+ Misses         36       34       -2     
- Partials        6       11       +5

Impacted Files	Coverage Δ
src/kitovu/sync/syncing.py	94.11% <0%> (-5.89%)	:arrow_down:
src/kitovu/sync/syncplugin.py	100% <0%> (ø)	:arrow_up:
tests/test_dummyplugin.py	100% <0%> (ø)	:arrow_up:
tests/sync/test_smb.py	100% <0%> (ø)	:arrow_up:
tests/helpers/dummyplugin.py	100% <0%> (ø)	:arrow_up:
tests/conftest.py	100% <0%> (ø)	:arrow_up:
src/kitovu/gui/mainwindow.py	96.66% <0%> (ø)
tests/gui/test_startscreen.py	100% <0%> (ø)
src/kitovu/sync/filecache.py	96.82% <0%> (ø)
tests/gui/test_confscreen.py	100% <0%> (ø)
... and 14 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update fa617c4...dbb7149. Read the comment docs.

[The-Compiler]

Why do we have to document the whole codebase? That doesn't really make much sense to me... AbstractSyncPlugin is pretty much the only thing relevant to plugin authors, no?

[ThunderKey]

I prefer to have one location where the complete documentation is. Even if it's just an overview of all methods and child objects. For me it's a nice entrypoint to see where I can find which parts of the code

[The-Compiler]

I see your point, but this is the documentation intended for users of the software. From an users perspective, this is "useless noise" - or even worse: By documenting all our code at the place we point plugin authors to, we pledge to keep a stable API suitable to be used in plugins everywhere, which we just can't.

I'll merge this for now to not block things, but let's discuss this tomorrow (I added it to the meeting notes)