Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #648

Merged
merged 9 commits into from
Nov 6, 2018
Merged

Documentation #648

merged 9 commits into from
Nov 6, 2018

Conversation

juliusknorr
Copy link
Member

Summary

General and API documentation built with readthedocs

Preview for this branch:
https://deck.readthedocs.io/en/documentation/

TODO

  • Finish API documentation
  • Link in README

Checklist

  • Code is properly formatted
  • Sign-off message is added to all commits
  • Tests (unit, integration, api and/or acceptance) are included
  • Documentation (manuals or wiki) has been updated or is not required

@codecov
Copy link

codecov bot commented Oct 13, 2018

Codecov Report

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

@@           Coverage Diff           @@
##           master     #648   +/-   ##
=======================================
  Coverage   76.27%   76.27%           
=======================================
  Files          58       58           
  Lines        2575     2575           
=======================================
  Hits         1964     1964           
  Misses        611      611

Signed-off-by: Julius Härtl <[email protected]>
Signed-off-by: Julius Härtl <[email protected]>
Signed-off-by: Julius Härtl <[email protected]>
thanks to @desperateCoder for drawing an er diagram

Signed-off-by: Julius Härtl <[email protected]>
Signed-off-by: Julius Härtl <[email protected]>
Signed-off-by: Julius Härtl <[email protected]>
@juliusknorr
Copy link
Member Author

Let's merge this as a first step, it should contain all necessary information to get started and we can still improve later.

@juliusknorr juliusknorr merged commit a22c152 into master Nov 6, 2018
@juliusknorr juliusknorr deleted the documentation branch November 6, 2018 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant