wehub-resource-sync
c56bef871b
Sync docs with Docusaurus / sync (push) Waiting to run
Tests / Check if changed (push) Waiting to run
Tests / format (push) Blocked by required conditions
Tests / check-imports (push) Blocked by required conditions
Tests / Unit / macos-latest (push) Blocked by required conditions
Tests / Unit / ubuntu-latest (push) Blocked by required conditions
Tests / Unit / windows-latest (push) Blocked by required conditions
Tests / mypy (push) Blocked by required conditions
Tests / Integration / ubuntu-latest (push) Blocked by required conditions
Tests / Integration / macos-latest (push) Blocked by required conditions
Tests / Integration / windows-latest (push) Blocked by required conditions
Tests / notify-slack-on-failure (push) Blocked by required conditions
Tests / Mark tests as completed (push) Blocked by required conditions
Update Platform Components Table / update (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
Docker image release / Build base image (push) Waiting to run
📒 Looking for the docs?
You can find Haystack's documentation at https://docs.haystack.deepset.ai/.
API Reference
We use haystack-pydoc-tools to create Markdown files from the docstrings in our code. There is a Github workflow that regenerates the API reference when code changes.
If you want to generate a new Markdown file for a new Haystack module, create a .yml file in pydoc which configures how haystack-pydoc-tools will generate the page and commit it to main.
All the updates to API reference live in unstable docs version and are promoted to stable docs version when a new version is released.
Configuration
For configuration details, see the haystack-pydoc-tools documentation or inspect the existing .yml files in pydoc.