Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically run examples in docs? #117

Open
cbrnr opened this issue Aug 9, 2022 · 3 comments
Open

Automatically run examples in docs? #117

cbrnr opened this issue Aug 9, 2022 · 3 comments

Comments

@cbrnr
Copy link
Owner

cbrnr commented Aug 9, 2022

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.

@hofaflo
Copy link
Collaborator

hofaflo commented Oct 23, 2022

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.

@cbrnr
Copy link
Owner Author

cbrnr commented Oct 24, 2022

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

@cbrnr cbrnr closed this as completed Oct 24, 2022
@cbrnr cbrnr reopened this May 3, 2023
@cbrnr
Copy link
Owner Author

cbrnr commented May 3, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants