sleepecg icon indicating copy to clipboard operation
sleepecg copied to clipboard

Automatically run examples in docs?

Open cbrnr opened this issue 3 years ago • 3 comments

I don't know if this is even possible, but it would be nice to run the examples in the docs automatically and include their output (e.g. figures, text output, ...) in the docs. Currently, this has to be done manually.

cbrnr avatar Aug 09 '22 15:08 cbrnr

This would be nice, but e.g. the benchmarks take a really long time and don't change that often, so I think this would be overkill for the current state of the project.

hofaflo avatar Oct 23 '22 20:10 hofaflo

I agree. Sure we could exclude the benchmarks, but even then I don't think it is worth the effort right now.

cbrnr avatar Oct 24 '22 07:10 cbrnr

I'm reopening this, because I think it is useful to run the smaller examples and include their output. It looks like https://pawamoy.github.io/markdown-exec/ can be used for that purpose.

cbrnr avatar May 03 '23 07:05 cbrnr