mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-07-28 19:29:40 +00:00
7fdb85d63a
* Skeleton of doc website * Flesh out documentation pages * Split concepts into their own rst files * add tutorial rsts * Consistent level 1 markdown headers in tutorials * Change theme to readthedocs * Turn bullet points into prose * Populate sections * Add more text * Add more sphinx files * Add more retriever documentation * combined all documenations in one structure * rename of src to _src as it was ignored by git * Incorporate MP2's changes * add benchmark bar charts * Adapt docstrings in Readers * Improvements to intro, creation of glossary * Adapt docstrings in Retrievers * Adapt docstrings in Finder * Adapt Docstrings of Finder * Updates to text * Edit text * update doc strings * proof read tutorials * Edit text * Edit text * Add stacked chart * populate graph with data * Switch Documentation to markdown (#386) * add way to generate markdown files to sphinx * changed from rst to markdown and extended sphinx for it * fix spelling * Clean titles * delete file * change spelling * add sections to document store usage * add basic rest api docs * fix readme in setup.py * Update Tutorials * Change section names * add windows note to pip install * update intro * new renderer for markdown files * Fix typos * delete dpr_utils.py * fix windows note in get started * Fix docstrings * deleted rest api docs in api * fixed typo * Fix docstring * revert readme to rst * Fix readme * Update setup.py Co-authored-by: deepset <deepset@Crenolape.localdomain> Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com> Co-authored-by: Bogdan Kostić <bogdankostic@web.de> Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai>
44 lines
1.1 KiB
YAML
44 lines
1.1 KiB
YAML
loaders:
|
|
- type: python
|
|
search_path: [../haystack]
|
|
processor:
|
|
- type: filter
|
|
expression: not name.startswith('_') and default()
|
|
- documented_only: true
|
|
- do_not_filter_modules: false
|
|
- skip_empty_modules: true
|
|
renderer:
|
|
type: mkdocs
|
|
pages:
|
|
- title: DocumentStore
|
|
contents:
|
|
- document_store.base.*
|
|
- document_store.elasticsearch.*
|
|
- document_store.memory.*
|
|
- document_store.sql.*
|
|
- title: Retriever
|
|
contents:
|
|
- retriever.base.*
|
|
- retriever.dense.*
|
|
- retriever.sparse.*
|
|
- title: Reader
|
|
contents:
|
|
- reader.base.*
|
|
- reader.farm.*
|
|
- reader.transformers.*
|
|
- title: Preprocessing
|
|
contents:
|
|
- preprocessor.cleaning.*
|
|
- preprocessor.utils.*
|
|
- title: File Converters
|
|
contents:
|
|
- file_converter.base.*
|
|
- file_converter.docx.*
|
|
- file_converter.pdf.*
|
|
- file_converter.txt.*
|
|
- file_converter.tika.*
|
|
mkdocs_config:
|
|
mkdocs_config:
|
|
site_name: Haystack
|
|
theme: readthedocs
|