From 26680ca12640454254dc8d93a5a84649d06c96bb Mon Sep 17 00:00:00 2001
From: Stefano Fiorucci <stefanofiorucci@gmail.com>
Date: Fri, 2 Feb 2024 14:22:36 +0100
Subject: [PATCH] api docs (#325)

---
 .github/workflows/pgvector.yml         | 12 ++++++++---
 integrations/pgvector/pydoc/config.yml | 30 ++++++++++++++++++++++++++
 integrations/pgvector/pyproject.toml   |  4 ++++
 3 files changed, 43 insertions(+), 3 deletions(-)
 create mode 100644 integrations/pgvector/pydoc/config.yml

diff --git a/.github/workflows/pgvector.yml b/.github/workflows/pgvector.yml
index c985b765a..badb2565b 100644
--- a/.github/workflows/pgvector.yml
+++ b/.github/workflows/pgvector.yml
@@ -18,6 +18,10 @@ env:
   PYTHONUNBUFFERED: "1"
   FORCE_COLOR: "1"
 
+defaults:
+  run:
+    working-directory: integrations/pgvector  
+
 jobs:
   run:
     name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
@@ -49,10 +53,12 @@ jobs:
         run: pip install --upgrade hatch
 
       - name: Lint
-        working-directory: integrations/pgvector
         if: matrix.python-version == '3.9'
-        run: hatch run lint:all  
+        run: hatch run lint:all
+
+      - name: Generate docs
+        if: matrix.python-version == '3.9' && runner.os == 'Linux'
+        run: hatch run docs          
 
       - name: Run tests
-        working-directory: integrations/pgvector
         run: hatch run cov
diff --git a/integrations/pgvector/pydoc/config.yml b/integrations/pgvector/pydoc/config.yml
new file mode 100644
index 000000000..79974b4a1
--- /dev/null
+++ b/integrations/pgvector/pydoc/config.yml
@@ -0,0 +1,30 @@
+loaders:
+  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+    search_path: [../src]
+    modules: [
+      "haystack_integrations.components.retrievers.pgvector.embedding_retriever",
+      "haystack_integrations.document_stores.pgvector.document_store",
+      "haystack_integrations.document_stores.pgvector.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: Pgvector integration for Haystack
+  category_slug: haystack-integrations
+  title: Pgvector
+  slug: integrations-pgvector
+  order: 140
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: _readme_pgvector.md
diff --git a/integrations/pgvector/pyproject.toml b/integrations/pgvector/pyproject.toml
index b361af8b1..10ef5d314 100644
--- a/integrations/pgvector/pyproject.toml
+++ b/integrations/pgvector/pyproject.toml
@@ -51,6 +51,7 @@ dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
   "ipython",
+  "haystack-pydoc-tools",  
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
@@ -63,6 +64,9 @@ cov = [
   "test-cov",
   "cov-report",
 ]
+docs = [
+  "pydoc-markdown pydoc/config.yml"
+]
 
 [[tool.hatch.envs.all.matrix]]
 python = ["3.8", "3.9", "3.10", "3.11", "3.12"]