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

[Feature Request]: Automatically extract all the code examples from the documentation and run them as "tests" #289

Open
Weyaaron opened this issue Jul 17, 2023 · 1 comment
Labels
feature Have an idea on how to improve the code base? Come forward and let us know.

Comments

@Weyaaron
Copy link
Collaborator

Problem statement

Our documentation uses a lot of examples. We should maintain them, which includes updating them when the codebase beneath changes. To ease maintenance, we may implement a script that runs all the provided examples. This could be done continuously with each PR or in a manual step before each release.

Solution

The solution probably involves some sort of markdown parsing, and if it should run continuously, altering the CI accordingly.

Additional Context

No response

@Weyaaron Weyaaron added the feature Have an idea on how to improve the code base? Come forward and let us know. label Jul 17, 2023
@dobbersc
Copy link
Collaborator

This project may help: https://github.com/basnijholt/markdown-code-runner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Have an idea on how to improve the code base? Come forward and let us know.
Projects
None yet
Development

No branches or pull requests

2 participants