Commit Graph

9 Commits

Author SHA1 Message Date
Stefano Fiorucci 07e8c9bad8 docs: revert adopting JSX comments (#11119)
* Revert "Sync Haystack API reference on Docusaurus (#11118)"

This reverts commit 8d9df4c156.

* Revert "docs(snippets): replace HTML comments with JSX comments for MDX v4 compatibility (#11117)"

This reverts commit 2b1ca620a0.
2026-04-16 10:09:47 +00:00
Aftab 2b1ca620a0 docs(snippets): replace HTML comments with JSX comments for MDX v4 compatibility (#11117)
Replace all `<!-- test-ignore -->` HTML comment markers in Python docstrings
and generated API reference docs with JSX comments `{/* test-ignore */}` to be
compatible with strict MDX parsing in Docusaurus v4.

Also update test_python_snippets.py to use the new JSX marker format for
`TEST_IGNORE_MARK`, `TEST_CONCEPT_MARK`, `TEST_RUN_MARK`, and
`TEST_REQUIRE_FILES_PREFIX` constants, and remove the `mdx1Compat: { comments: true }`
compatibility setting from docusaurus.config.js.

Closes #11104
2026-04-16 09:15:12 +00:00
David S. Batista b6d94498f9 test: running docstrings code snippets which generate API docs (#10993)
* adding test-ignore to snippets that require API keys

* adding test-ignore to snippets that require extra dependencies

* fixing wrong placement of ignore tag

* adding ignore to fixture files / bad placeholders / network calls

* Revert "adding test-ignore to snippets that require API keys"

This reverts commit 35ca3cd6a00cc5192089e6f3b79ce393a23fcc4a.

* Reapply "adding test-ignore to snippets that require API keys"

This reverts commit e3cca7a8544e528a863fd18f5dd1b5c8d421f8b4.

* Revert "adding ignore to fixture files / bad placeholders / network calls"

This reverts commit ba8f685de9653f1d5f144ab6ac5de8cf4bae7557.

* Revert "fixing wrong placement of ignore tag"

This reverts commit f3869316732a58bf8a966b872548f896610a0716.

* Revert "adding test-ignore to snippets that require extra dependencies"

This reverts commit 55b1fdb8a1d3ed89aa9768fd6cdf7e2d7787714a.

* Revert "adding test-ignore to snippets that require API keys"

This reverts commit 35ca3cd6a00cc5192089e6f3b79ce393a23fcc4a.

* fixing some more code snippets and ignoring some

* fixing some more code snippets and ignoring some

* adding fixture files from tests

* setting path in workflow file

* activating push triggers

* using gtp-4o-mini

* generating new md files

* install hatch

* install hatch

* install ffmpeg

* debugging

* debugging

* debugging

* adding extra requirements

* Update .github/workflows/docs-website-test-docs-snippets.yml

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>

* Apply suggestion from @anakin87

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>

* Apply suggestion from @anakin87

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>

* Apply suggestion from @anakin87

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>

* wip

* wip

* wip

* wip

* running OpenAPIServiceConnector docstring code

* running OpenAPIConnector docstring code

* running OpenAI Embedder docstring code

* temporary enabling running on PR

* running serperdev code snippets

* using test files for the llm_document_content_extractor.py docstring

* adding AZURE env vars and step summary to github

* adding more embbeders to run

* temporary disabling openai text embedder

* debugging error on text embedders docstring

* cleaning + installing dev deps from pyproject.toml

* trying use deps from pyproject.toml

* skip script to generate dependencies

* debugging error embedders docstring

* debugging

* debugging

* debugging: reverting to external requirements

* using pyproject.toml dependencies + disabling SERPERDEV code snippets

* removing extra requirements.txt

* adding slack notification + disabling one more snippet relying on SERPERDEV

* removing all triggers runs only daily at 3:17 and has a workflow_dispatch

---------

Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
2026-04-01 11:39:35 +00:00
Stefano Fiorucci 819ed7244b chore: drop pylint (#10640)
* draft

* progress

* more fixes

* improvs

* strict

* rm pylint

* rm pylint comments

* fix and simplify

* standardize

* more

* alpha order

* final touch

* remove template

* rm ellipsis comments
2026-02-24 07:46:20 +00:00
Stefano Fiorucci 7c6323b960 refactor: support PEP604 typing syntax (X|Y and X|None) (#10255)
* adopt X|Y syntax: draft

* cast Union

* fix pylint + state testing

* use X|Y

* rm unused imports

* trigger e2e tests

* fix + simplification

* add compatibility tests

* rm e2e tests trigger

* fix

* add relnote

* simplify/fix pep604 union parsing

* fix comments

* test _is_optional_type

* introduce _build_pep604_union_type; make _is_union_type private

* try removing problematic test
2025-12-19 15:47:51 +01:00
Vladimir Blagojevic 4a56d52b60 chore: Update code snippets in docs (audio and builders components) (#10156)
* Update code snippets in docs

* Add reno note

* Revert "Add reno note"

This reverts commit 18733fa828ebedfe5b20903bcf0080abc198ad9e.

* PR feedback

* Minor fix

* No Secrets between us

* Comments format update

* Restore output format

* Script output, needs to be commented
2025-12-11 15:06:54 +01:00
Vladimir Blagojevic df3b13857e feat: Enable first snippet test runs in new documentation (#9967)
* Enable first snippet test runs in docs

* Move improved agent example to pydoc

* Linting docs

* Add pylint disable for too-many-positional-arguments
2025-11-06 10:26:56 +01:00
Daria Fokina a71dd7d2aa update license headers (#9861) 2025-10-10 12:04:48 +02:00
Daria Fokina a66a05f756 docs: moving Docusaurus setup to Haystack repo (#9847)
* move-docusarus-to-haystack

* debug

* add src

* blank page bug

* unify readme
2025-10-10 11:44:13 +02:00