-
Notifications
You must be signed in to change notification settings - Fork 2.5k
feat: Enable first snippet test runs in new documentation #9967
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
|
Also, @vblagoje , the docstrings of the agent component themselves need to be updated, then the agents reference markdown will be populated with the correct code snippet :) |
Pull Request Test Coverage Report for Build 18969835544Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
|
Hm @dfokina but now that I've changed agent.py pydoc to include these details - it is not showing up in the docs, know why? |
|
@vblagoje that's because the change would need to be merged first to trigger the pydoc regeneration |
|
@vblagoje you can do a separate PR with that, I can quickly approve & we'll see the change in latest (2.20) docs :) |
|
Ah ok, I'll add it b4 EOD. We need better example for the main agent.py pydoc |
|
@dfokina the agent.py pydocs changes are not shown in https://haystack-docs-bva8zi58y-deepset-ai.vercel.app/reference/next/agents-api |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤞
agents_api.mdand then expand from there with more PRs per sectiondocs-website/reference/haystack-api/agents_api.mdin the future to add more dirs/files