re-organize pydoc config files (#4042)

.github/utils/pydoc-markdown.sh

@@ -2,9 +2,9 @@
 
 set -e   # Fails on any error in the following loop
 export PYTHONPATH=$PWD/docs/pydoc # Make the renderers available to pydoc
-cd docs/_src/api/api/
+cd docs/pydoc
 rm -rf temp && mkdir temp
 cd temp
-for file in ../../pydoc/* ; do
+for file in ../config/* ; do
     pydoc-markdown "$file"
 done

.gitignore

@@ -74,8 +74,8 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
+# documentation
+docs/pydoc/temp/
 
 # PyBuilder
 target/

docs/pydoc/config/answer-generator.yml

@@ -1,6 +1,6 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/answer_generator]
+    search_path: [../../../haystack/nodes/answer_generator]
     modules: ['base', 'transformers', 'openai']
     ignore_when_discovered: ['__init__']
 processors:

docs/pydoc/config/crawler.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/connector]
+    search_path: [../../../haystack/nodes/connector]
     modules: ['crawler']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/document-classifier.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/document_classifier]
+    search_path: [../../../haystack/nodes/document_classifier]
     modules: ['base', 'transformers']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/document-store.yml

@@ -1,6 +1,6 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/document_stores]
+    search_path: [../../../haystack/document_stores]
     modules: ['base', 'elasticsearch', 'opensearch', 'memory', 'sql', 'faiss', 'milvus', 'weaviate', 'graphdb', 'deepsetcloud', 'pinecone', 'search_engine', 'utils']
     ignore_when_discovered: ['__init__']
 processors:

docs/pydoc/config/evaluation.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/evaluator]
+    search_path: [../../../haystack/nodes/evaluator]
     modules: ['evaluator']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/extractor.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/extractor]
+    search_path: [../../../haystack/nodes/extractor]
     modules: ['entity']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/file-classifier.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/file_classifier]
+    search_path: [../../../haystack/nodes/file_classifier]
     modules: ['file_type']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/file-converters.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/file_converter]
+    search_path: [../../../haystack/nodes/file_converter]
     modules: ['base', 'csv', 'docx', 'image', 'markdown', 'pdf', 'parsr', 'azure', 'tika', 'txt']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/other.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/other]
+    search_path: [../../../haystack/nodes/other]
     modules: ['docs2answers', 'join_docs', 'join_answers', 'route_documents', 'document_merger']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/pipelines.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/pipelines]
+    search_path: [../../../haystack/pipelines]
     modules: ['base', 'ray', 'standard_pipelines']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/preprocessor.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/preprocessor]
+    search_path: [../../../haystack/nodes/preprocessor]
     modules: ['base', 'preprocessor']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/primitives.yml

@@ -1,6 +1,6 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack]
+    search_path: [../../../haystack]
     modules: ['schema']
     ignore_when_discovered: ['__init__']
 processors:

docs/pydoc/config/prompt-node.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/prompt]
+    search_path: [../../../haystack/nodes/prompt]
     modules: ['prompt_node']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/pseudo-label-generator.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/label_generator]
+    search_path: [../../../haystack/nodes/label_generator]
     modules: ['pseudo_label_generator']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/query-classifier.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/query_classifier]
+    search_path: [../../../haystack/nodes/query_classifier]
     modules: ['base', 'sklearn', 'transformers']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/question-generator.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/question_generator]
+    search_path: [../../../haystack/nodes/question_generator]
     modules: ['question_generator']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/ranker.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/ranker]
+    search_path: [../../../haystack/nodes/ranker]
     modules: ['base', 'sentence_transformers']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/reader.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/reader]
+    search_path: [../../../haystack/nodes/reader]
     modules: ['base', 'farm', 'transformers', 'table']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/retriever.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/retriever]
+    search_path: [../../../haystack/nodes/retriever]
     modules: ['base', 'sparse', 'dense', 'text2sparql', 'multimodal/retriever']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/summarizer.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/summarizer]
+    search_path: [../../../haystack/nodes/summarizer]
     modules: ['base', 'transformers']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/transformers-img-to-text.yml

@@ -1,11 +1,11 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/image_to_text]
+    search_path: [../../../haystack/nodes/image_to_text]
     modules: ['base', 'transformers']
     ignore_when_discovered: ['__init__']
 processors:
   - type: filter
-    expression: 
+    expression:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true

docs/pydoc/config/translator.yml

@@ -1,6 +1,6 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/nodes/translator]
+    search_path: [../../../haystack/nodes/translator]
     modules: ['base', 'transformers']
     ignore_when_discovered: ['__init__']
 processors:

docs/pydoc/config/utils.yml

@@ -1,6 +1,6 @@
 loaders:
   - type: python
-    search_path: [../../../../haystack/utils]
+    search_path: [../../../haystack/utils]
     modules: ['doc_store', 'export_utils', 'preprocessing', 'squad_data', 'early_stopping', 'cleaning', 'context_matching', 'deepsetcloud', 'docker']
     ignore_when_discovered: ['__init__']
 processors: