Branden Chan 7fdb85d63a
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

58 lines
1.2 KiB
HTML

{% extends "layout.html" %}
{% set title = _('Overview') %}
{% block body %}
<h1>Haystack Documentation</h1>
<p>
{{ _('Welcome! This is') }}
{% block description %}{{ _('the documentation for') }} Haystack
{% endblock %}.
</p>
{% block tables %}
<h2>Haystack</h2>
<table class="contentstable" align="center">
<tr>
<td width="50%">
<p class="biglink">
<a class="biglink" href="">
What can Haystack do?
</a>
<br />
</p>
<td width="50%">
<p class="biglink">
<a class="biglink" href="">
Conceptual overview
</a>
</td>
</tr>
</table>
<h2>Getting started</h2>
<table class="contentstable" align="center">
<tr>
<td width="50%">
<p class="biglink">
<a class="biglink" href="">
Installation guides
</a>
</p>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto("ddocs/views/intro") }}">
Tutorial
</a>
</p>
</td>
</tr>
</table>
<h2>Links</h2>
<table class="contentstable" align="center"><tr>
<td>
<p class="biglink"><a class="biglink" href="">Download Haystack</a></p>
</td></tr>
</table>
{% endblock %}
{% endblock %}