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

Execute code snippets in docs #730

Open
callumforrester opened this issue Nov 28, 2024 · 0 comments
Open

Execute code snippets in docs #730

callumforrester opened this issue Nov 28, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@callumforrester
Copy link
Contributor

In order to prevent the docs build from going out of date we should execute the code snippets and the make the docs build, see ophyd-async for a possible solution

Acceptance Criteria

  • Code snippets in docs are executed
  • If execution fails, the docs build fails
@callumforrester callumforrester added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant