Include markdown readme in sphinx index

[marscher]

Changes

Include Readme and Changelog markdown files from repo root into the sphinx documentation. It uses the extension m2r2 which converts the Md files into rst.

Related Issues

Closes #406

Checks

• updated doc/

[CagtayFabry]

LGTM 🧐

[marscher]

https://weldx--415.org.readthedocs.build/en/415/index.html The heading level of "Python API" should be the same as the ones in README.md.

And somehow the logo is not being displayed (firefox).

[marscher]

weldx--415.org.readthedocs.build-1626170700058.log
Seems like the logo is not shipped anymore.

[CagtayFabry]

weldx--415.org.readthedocs.build-1626170700058.log
Seems like the logo is not shipped anymore.

good catch !

[CagtayFabry]

https://weldx--415.org.readthedocs.build/en/415/index.html The heading level of "Python API" should be the same as the ones in README.md.

And somehow the logo is not being displayed (firefox).

thought that was intended, I'll fix it
https://github.com/crossnox/m2r2#restrictions

[CagtayFabry]

weldx--415.org.readthedocs.build-1626170700058.log
Seems like the logo is not shipped anymore.

good catch !

the logo does get shipped but somehow the link get's set to ..../_static/_static/WelDX_notext.svg instead of just ..../_static/WelDX_notext.svg as before..., might be an issue with the current pydata theme

[CagtayFabry]

seems to be a sphinx issue introduced in 4.1, see sphinx-doc/sphinx#9438 sphinx-doc/sphinx#9381

[codecov]

Codecov Report

Merging #415 (9e07760) into master (4c5c01c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #415   +/-   ##
=======================================
  Coverage   97.27%   97.27%           
=======================================
  Files          87       87           
  Lines        5352     5352           
=======================================
  Hits         5206     5206           
  Misses        146      146           

Impacted Files	Coverage Δ
weldx/welding/__init__.py	100.00% <ø> (ø)

---

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 4c5c01c...9e07760. Read the comment docs.