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

Pgvector: generate API docs #325

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
12 changes: 9 additions & 3 deletions .github/workflows/pgvector.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/pgvector

jobs:
run:
name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
Expand Down Expand Up @@ -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
30 changes: 30 additions & 0 deletions integrations/pgvector/pydoc/config.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions integrations/pgvector/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ dependencies = [
"coverage[toml]>=6.5",
"pytest",
"ipython",
"haystack-pydoc-tools",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
Expand All @@ -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"]
Expand Down