Skip to content

test: Check Python code snippets in docstrings - #404

Open
hsemenenko wants to merge 1 commit into
mainfrom
hs/docs/check-code-snippets
Open

hsemenenko wants to merge 1 commit into
mainfrom
hs/docs/check-code-snippets

Conversation

@hsemenenko

@hsemenenko hsemenenko commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

This PR adds the doctest package to Sphinx to run all .. testcode:: blocks in docstrings. It does not work well with Guppy as the source is not directly available, so the PR adds a helper script to extract code snippets into temp file to be run.

Closes #379

@hsemenenko hsemenenko changed the title docs: Check Python code snippets in docstrings test: Check Python code snippets in docstrings Sep 16, 2026
@hsemenenko
hsemenenko requested a review from CalMacCQ September 16, 2026 09:50
@hsemenenko
hsemenenko marked this pull request as ready for review September 16, 2026 09:50
@hsemenenko
hsemenenko requested a review from a team as a code owner September 16, 2026 09:50
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

Successfully merging this pull request may close these issues.

[Docs]: Find a way to check all docs code snippets

1 participant