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.

Sign up for GitHub

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

Jump to bottom

Test examples embeded in docs/ Markdown documents #136

Open
llucax opened this issue Sep 18, 2023 · 0 comments
Open

Test examples embeded in docs/ Markdown documents #136

llucax opened this issue Sep 18, 2023 · 0 comments
Labels
part:cookiecutter Affects the generation of projects using cookiecutter part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests type:enhancement New feature or enhancement visitble to users
Milestone
v0.11.0

Comments

@llucax
Copy link
Contributor

llucax commented Sep 18, 2023

What's needed?

The documentation in docs/ usually also host some code examples, so we should make sure they stay up to date too.

Proposed solution

Use Sybil or other tool to extract the examples, and then run the linters, checkers, etc.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response
@llucax llucax added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests type:enhancement New feature or enhancement visitble to users part:cookiecutter Affects the generation of projects using cookiecutter labels Sep 18, 2023
@llucax llucax modified the milestones: v0.8.0, v0.7.0 Sep 18, 2023
@llucax llucax modified the milestones: v0.8.0, v0.10.0 Nov 1, 2023
@llucax llucax mentioned this issue Nov 6, 2023
Open
@llucax llucax modified the milestones: v0.10.0, v0.11.0 Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
part:cookiecutter Affects the generation of projects using cookiecutter part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
v0.11.0
Development

No branches or pull requests
1 participant
@llucax