feat: Generate API docs (#262)

* ignore docs generation by-products

* add pydoc config file

* hatch run docs

* generate docs as smoke test

* split the steps for easier debugging

* split pydoc config

* update pydoc pattern

* single-page version

* newline

* upd parent category

---------

Co-authored-by: Daria Fokina <[email protected]>

.github/workflows/chroma.yml

@@ -52,5 +52,9 @@ jobs:
       if: matrix.python-version == '3.9' && runner.os == 'Linux'
       run: hatch run lint:all
 
+    - name: Generate docs
+      if: matrix.python-version == '3.9' && runner.os == 'Linux'
+      run: hatch run docs
+
     - name: Run tests
-      run: hatch run cov
+      run: hatch run cov

.gitignore

@@ -131,3 +131,6 @@ dmypy.json
 
 # IDEs
 .vscode
+
+# Docs generation artifacts
+_readme_*.md

integrations/chroma/pydoc/config.yml

@@ -0,0 +1,31 @@
+loaders:
+  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+    search_path: [../src]
+    modules: [
+      "haystack_integrations.components.retrievers.chroma.retriever",
+      "haystack_integrations.document_stores.chroma.document_store",
+      "haystack_integrations.document_stores.chroma.errors",
+      "haystack_integrations.document_stores.chroma.utils",
+    ]
+    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: Chroma integration for Haystack
+  category_slug: haystack-integrations
+  title: Chroma
+  slug: integrations-chroma
+  order: 1
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: _readme_chroma.md

integrations/chroma/pyproject.toml

@@ -47,6 +47,7 @@ git_describe_command = 'git describe --tags --match="integrations/chroma-v[0-9]*
 dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
+  "haystack-pydoc-tools",
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
@@ -59,6 +60,9 @@ cov = [
   "test-cov",
   "cov-report",
 ]
+docs = [
+  "pydoc-markdown pydoc/config.yml"
+]
 
 [[tool.hatch.envs.all.matrix]]
 python = ["3.9", "3.10"]