test: running docstrings code snippets which generate API docs

[davidsbatista]

Related Issues

• fixes

Proposed Changes:

Typical reasons for failing which were fixed:

• Missing API Keys
• Missing Optional Dependencies
• Missing test files (e.g.: sample.pdf, sample.xls)

The majority are skipped because of the heuristic:

• No import statement detected; treated as concept/illustrative

How did you test it?

• local workflow loop:
  • code changes
  • manual generation of .md
  • running test script over md files
• CI tests

Checklist

• I have read the contributors guidelines and the code of conduct.
• I have updated the related issue with new insights and changes.
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
• I have run pre-commit hooks and fixed any issue.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
haystack-docs	Ignored	Preview	Apr 1, 2026 11:29am

[coveralls]

Pull Request Test Coverage Report for Build 23846355211

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 131 unchanged lines in 28 files lost coverage.
• Overall coverage decreased (-0.01%) to 92.892%

---

Files with Coverage Reduction	New Missed Lines	%
components/converters/docx.py	1	99.43%
components/embedders/image/sentence_transformers_doc_image_embedder.py	1	98.72%
components/generators/openai_dalle.py	1	95.45%
components/rankers/hugging_face_tei.py	1	98.59%
components/websearch/searchapi.py	1	98.65%
components/converters/pptx.py	2	97.1%
components/converters/pypdf.py	2	95.95%
components/converters/txt.py	2	91.18%
components/embedders/azure_document_embedder.py	2	96.0%
components/embedders/azure_text_embedder.py	2	95.45%

Totals
Change from base Build 23846041765:	-0.01%
Covered Lines:	15878
Relevant Lines:	17093

---

💛 - Coveralls

[davidsbatista]

@anakin87 feel free to review - I'm removing some of the <!-- test-ignore -->

[anakin87]

I opened a PR with mypy fixes: #11003

[anakin87]

Looks good.

I suggest opening two additional issues: one about testing more ignored snippets, the other about standardizing print outputs in code examples (we might also let community contributors do this).