feat: documentation snippet testing with literalinclude and Pydantic validation

[raballew]

Summary

• Extract inline code snippets from 44 driver READMEs into standalone files under each driver's examples/ directory, referenced via {literalinclude} directives
• All YAML configs use full Kubernetes-style syntax (apiVersion, kind, metadata) and are validated against Pydantic models (ExporterConfigV1Alpha1, HookConfigV1Alpha1, etc.)
• Python examples are syntax-checked via compile() and import-checked via importlib
• Shared test infrastructure in jumpstarter.testing.checks (file discovery, unused/inline detection) and jumpstarter.testing.examples (model validation)
• Each driver's examples_test.py is a thin 30-line file that imports shared logic -- changing check rules requires editing one file, not 44
• Every examples_test.py enforces:
  • test_example -- validates each example file against the appropriate Pydantic model
  • test_no_unused_examples -- fails if config*.yaml or usage*.py files are not referenced in README
  • test_no_inline_code_blocks -- fails if README has bare ```yaml or ```python fences instead of {literalinclude} or {code-block}
• Driver creation template (create_driver.sh) updated to generate examples/config.yaml and examples_test.py for new drivers
• Sphinx doctest removed -- replaced by standalone example files with per-driver pytest validation
• make docs-test simplified to run pytest on example tests (no more Sphinx doctest runner)
• CI documentation workflow updated with docs-test job

Test plan

• make pkg-test-<driver> passes for representative drivers (e.g., yepkit, pyserial, mitmproxy)
• make docs-test runs documentation example tests
• make docs builds without literalinclude errors
• Verify test_no_inline_code_blocks catches bare ```yaml/ ```python fences
• Verify test_no_unused_examples catches unreferenced example files
• Create a new driver with create_driver.sh and verify it includes examples/config.yaml and examples_test.py

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9dc06a21-c580-40ca-aa7c-edc12bba86f9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}