haystack/docs/_src/usage/index.rst

24 lines
874 B
ReStructuredText
Raw Normal View History

Create documentation website (#272) * 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>
2020-09-18 12:57:32 +02:00
.. Haystack documentation master file, created by
sphinx-quickstart on Tue Jul 28 16:18:42 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Haystack is all you need to scale the latest advances in Question Answering technologies to large collections of documents.
Whether you're building a search system, asking standard questions to an incoming stream of documents or
extending your chatbot, Haystack has you covered.
This section covers the core concepts and practical usage of Haystack. See our tutorials page for end to end examples
or our API page for comprehensive descriptions of individual functions.
.. toctree::
:maxdepth: 4
:caption: Contents:
usage/intro
usage/get_started
usage/database
usage/retriever
usage/reader
usage/domain_adaptation
usage/terms