Fix README callout

[ofek]

No description provided.

[sisp]

Thanks for your PR! The problem with using this syntax is that we use the README on GitHub and also as the landing page of the MkDocs documentation, and Material for MkDocs doesn't recognize the GitHub syntax. I'm not aware of a single syntax that is recognized by both. The only solution I can think of right now is to use the GitHub syntax as you suggested and add a custom MkDocs hook that transforms it to the syntax that Material for MkDocs uses during the MkDocs build.

[pawamoy]

Thanks @ofek! Unfortunately I don't think this will render well once on ReadTheDocs. We'd have to write a Markdown extension that supports GitHub call outs (I don't think markdown-callouts does). It wouldn't be hard, just need a bit of time :)

EDIT: I answered before seeing @sisp's answer, oops ^^

[ofek]

I replaced it with standard markdown syntax, let me know what you think!

[ofek]

Just let me know!

[yajo]

Thanks!

I like more the callout in readthedocs, but at the same time it's true that the README is a landing place for many, so we can make the exception and stick with basic markdown here.

In the rest of the docs, obviously mkdocs styling has priority.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.32%. Comparing base (65b186a) to head (7ebda51).
Report is 93 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1651   +/-   ##
=======================================
  Coverage   97.32%   97.32%           
=======================================
  Files          49       49           
  Lines        5004     5004           
=======================================
  Hits         4870     4870           
  Misses        134      134           

Flag	Coverage Δ
unittests	97.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[yajo]

If you rebase, our CI will try to autofix it.