Sphinx use myst-nb

[marscher]

Changes

• Sphinx uses myst-nb to directly include Markdown.
• moved tutorials to doc/src/ and removed copying code.
• Converted all remaining documents to MD.
• Notebooks gets executed myst-nb

TODOs

• add prologue to notebook processing.
• fix: skipping unknown output mime type: application/json [mystnb.unknown_mime_type] mime type application/json not supported executablebooks/MyST-NB#464
• fix: weldx/transformations/init.py:docstring of weldx.transformations.CoordinateSystemManager:1: WARNING: unknown document: 'tutorials/transformations_02_coordinate_system_manager'
• fix: weldx/transformations/init.py:docstring of weldx.transformations.LocalCoordinateSystem:1: WARNING: unknown document: 'tutorials/transformations_01_coordinate_systems'

Related Issues

Closes #745

Checks

• updated CHANGELOG.rst
• updated tests
• updated doc/
• update example/tutorial notebooks
• update manifest file

[github-actions]

Test Results

2 184 tests  ±0   2 183 ✔️ ±0   3m 57s ⏱️ +39s
       1 suites ±0          1 💤 ±0 
       1 files   ±0          0 ❌ ±0 

Results for commit c9cdd81. ± Comparison against base commit 132c576.

♻️ This comment has been updated with latest results.

[codecov]

Codecov Report

Merging #830 (c9cdd81) into master (132c576) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #830   +/-   ##
=======================================
  Coverage   96.83%   96.83%           
=======================================
  Files          92       92           
  Lines        6071     6071           
=======================================
  Hits         5879     5879           
  Misses        192      192           

Impacted Files	Coverage Δ
weldx/transformations/cs_manager.py	98.60% <ø> (ø)
weldx/transformations/local_cs.py	96.34% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[marscher]

Readthedocs is failing, because it cannot find conf.py (we moved that to doc/src/) and it then falls back to an autogenerated one.

[CagtayFabry]

Readthedocs is failing, because it cannot find conf.py (we moved that to doc/src/) and it then falls back to an autogenerated one.

The GH actions complains as well

Configuration error:
config directory doesn't contain a conf.py file (/home/runner/work/weldx/weldx/doc)
Error: Process completed with exit code 2.

[marscher]

Readthedocs is failing, because it cannot find conf.py (we moved that to doc/src/) and it then falls back to an autogenerated one.

There is a setting in the admin interface of RTD, but it seemed to be ignored 💩

[marscher]

rtd installs an old version of docutils (0.17), which makes the build fail. I'll try to pin to >0.19

[CagtayFabry]

begone RST 🧙 👍

[marscher]

🤣 in fact autosummary/autodoc still uses RST a lot. But at least we do not have to write it our self any more.