put examples in docs

[j042]

@clemens-fricke

[clemens-fricke]

The main problem currently is that the plotting via vedo is not working in headless mode. I have briefly looked into this in the tataratat/gustaf repo, but have not found a solution yet.

Solving this problem with headless mode is also something we should do in gustaf since that is the visualizing pre-backend we use. Otherwise, I have already readied the file examples/run_all_examples.py to be able to call and run all examples and notify the calling process if any example fails. I would guess that solving the problem with headless mode will enable us to call the examples in addition to the tests during CI/CD.

I am not sure if we could/want to include the examples in the pytest suite or automatically call them during these tests.

[jzwar]

As I don't want to open an issue for this:
There is some typesetting issues in steffi's part of the documentation. Some of the lower indices are not set properly and also there is an issue with the brackets used in the docs. We should update that in the next iteration
@j042

[j042]

good catch! @markriegler - can you take a look at this?

[markriegler]

I can look into it