opensearch: generate API docs (#324)

.github/workflows/opensearch.yml

@@ -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' }}
@@ -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

integrations/opensearch/pydoc/config.yml

@@ -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

integrations/opensearch/pyproject.toml

@@ -49,6 +49,7 @@ dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
   "pytest-xdist",
+  "haystack-pydoc-tools",
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
@@ -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"]