Add documentation

[tmichela]

No description provided.

[codecov-io]

Codecov Report

Merging #59 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #59   +/-   ##
=======================================
  Coverage   82.11%   82.11%           
=======================================
  Files           8        8           
  Lines         520      520           
=======================================
  Hits          427      427           
  Misses         93       93           

---

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 1972140...d7810df. Read the comment docs.

[takluyver]

We should remember to remove this from the user docs, and link to the new docs instead. IIRC, we had the idea that the it was best to keep all the documentation of Karabo bridge protocol & clients in one place, but it's never easy to maintain docs far away from the code they relate to.

[tmichela]

We should remember to remove this from the user docs,

Yes I will once this is hosted on RTD.

IIRC, we had the idea that the it was best to keep all the documentation of Karabo bridge protocol & clients in one place, but it's never easy to maintain docs far away from the code they relate to.

Yes, I remember that. But since this has a few more feature (simulation, server, serialziers) I figured that make sens to have the whole documentation in here. Also probably is is easier to find for people if it is next to the code.
The one part I not sure about if the specifics for usage at EuXFEL (https://in.xfel.eu/readthedocs/docs/data-analysis-user-documentation/en/latest/online.html#how-to-use-it-at-the-euxfel). It maybe that should stay in the user documentation (adding a link here pointing to it)

[codecov-commenter]

Codecov Report

Merging #59 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #59   +/-   ##
=======================================
  Coverage   82.11%   82.11%           
=======================================
  Files           8        8           
  Lines         520      520           
=======================================
  Hits          427      427           
  Misses         93       93           

---

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 1972140...16d2be2. Read the comment docs.