Skip to content
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

OpenSearch: generate API docs #324

Merged
merged 1 commit into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .github/workflows/opensearch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ env:
PYTHONUNBUFFERED: "1"
FORCE_COLOR: "1"

defaults:
run:
working-directory: integrations/opensearch

jobs:
run:
name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
Expand All @@ -40,14 +44,16 @@ jobs:
run: pip install --upgrade hatch

- name: Lint
working-directory: integrations/opensearch
if: matrix.python-version == '3.9'
run: hatch run lint:all

- name: Run opensearch container
working-directory: integrations/opensearch
run: docker-compose up -d

- name: Generate docs
if: matrix.python-version == '3.9' && runner.os == 'Linux'
run: hatch run docs

- name: Run tests
working-directory: integrations/opensearch
run: hatch run cov
31 changes: 31 additions & 0 deletions integrations/opensearch/pydoc/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../src]
modules: [
"haystack_integrations.components.retrievers.opensearch.bm25_retriever",
"haystack_integrations.components.retrievers.opensearch.embedding_retriever",
"haystack_integrations.document_stores.opensearch.document_store",
"haystack_integrations.document_stores.opensearch.filters",
]
ignore_when_discovered: ["__init__"]
processors:
- type: filter
expression:
documented_only: true
do_not_filter_modules: false
skip_empty_modules: true
- type: smart
- type: crossref
renderer:
type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
excerpt: OpenSearch integration for Haystack
category_slug: haystack-integrations
title: OpenSearch
slug: integrations-opensearch
order: 130
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: _readme_opensearch.md
5 changes: 5 additions & 0 deletions integrations/opensearch/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ dependencies = [
"coverage[toml]>=6.5",
"pytest",
"pytest-xdist",
"haystack-pydoc-tools",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
Expand All @@ -62,6 +63,10 @@ cov = [
"cov-report",
]

docs = [
"pydoc-markdown pydoc/config.yml"
]

[[tool.hatch.envs.all.matrix]]
python = ["3.8", "3.9", "3.10", "3.11"]

Expand Down