Automated tutorials based on Python script source

[knmcguire]

I started step-by-step tutorials a while ago in this issue #159, however it was quite labor intensive to do this all by hand.

That is why a while ago I've played around with writing a parser that can turn a python script into a full tutorial in markdown, which can be put on the website. Here you can find the source: https://github.com/knmcguire/auto-tutorial

It might be good to have all the (big) examples also as an tutorial format? And do we want to automatically link to the generated API doc of the cflib ?

[knmcguire]

This will be quite difficult to maintain to generate it all from the python. It might be better to take code snippets from the code itself.

[marios-stam]

An idea that could be useful is to write the tutorials as a jupyter notebook (.iypnb) and then use a Github Action that can convert the jupyter notebook into both Markdown and Python code, like this one. So if modifications are needed, by changing the notebook both the step-by-step tutorial and the Python code will be updated automatically.

[knmcguire]

This might be too complicated to do with the current website framework, but we can reconsider if we rebuild the website based on mkdocs. Namely the pmdown snippet extension https://facelessuser.github.io/pymdown-extensions/extensions/snippets/