search

averbis / averbis-python-api

Conveniently access the REST API of Averbis products using Python
Apache License 2.0
12 stars 4 forks source link

Adds a documentation section to the readme #14

Closed TorstenK91 closed 3 years ago

TorstenK91 commented 3 years ago

So far the only link to the readthedocs was in the little "readthedocs" tag on github, which is not that obvious imho. Hence, the added section. It also contains a little teaser to the example notebooks, which are to come. Here we could also add a link to the google colab notebook in the future, which should come together with the example jupyter notebooks.

codecov-io commented 3 years ago

Codecov Report

Merging #14 (4dd9649) into main (c93c269) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage   85.44%   85.44%           
=======================================
  Files          11       11           
  Lines         804      804           
=======================================
  Hits          687      687           
  Misses        117      117

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 c93c269...4dd9649. Read the comment docs.