Open sannant opened 2 years ago
We should include the examples in the documentation. They are then run every time the documentation rebuilds.
I think we already agreed on that. I implemented it in the adhesion documentation. With a separate workflow run that checks the esamples do not fail.
https://contactengineering.github.io/Adhesion/examples/adhesive_simulation_sphere.html
But the HTML rendering is broken
In order to avoid our example files to break as the repositories evolve, I think that a github workflow should run them.
By this occasion, we could:
publishing on my binder would be awesesome, since it will allow anybody to test or even use lightweight functionalities of our codes (for example the fourier synthesis, see https://github.com/sannant/binder_fourier_synthesis) without going through the trouble of installation.
Note that I copied the fourier synthesis to a separate binder repository because I was too lazy to figure out how to compile our requirements (FFTW, muFFT, etc..) on mybinder.
This could be a good first issue for someone that is already profficient with coding but needs to go through our examples to learn our code.