* new docs version
* Add latest docstring and tutorial changes
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* test pre commit hook
* test status
* test on this branch
* push generated docstrings and tutorials to branch
* fixed syntax error
* Add latest docstring and tutorial changes
* add files before commit
* catch commit error
* separate generation from deployment
* add deployment process for staging
* add current branch to payload
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* automate docstring and tutorial generation with every push to master
* test CI for current branch
* fixed yaml syntax
* add setupttools to install process
* checkout repo
* fixed command for shell script
* install wheel as it is needed for CI
* install mkdocs
* test without shell script
* use package from github actions
* test other configuration
* back to right config
* cleaning script
* WIP: First version of preprocessing tutorial
* stride renamed overlap, ipynb and py files created
* rename split_stride in test
* Update preprocessor api documentation
* define order for markdown files
* define order of modules in api docs
* Add colab links
* Incorporate review feedback
Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com>
* new docs version
* updated directory structure
* Add pipelines page
* Add Finder deprecation suggestion
* header for pipelines file
* Document MySQL support
* Mention DPR train tutorial coming soon
* Mention open distro ES
* Update doc strings regarding similarity fn
* Add link to API docs
* Wrap pipelines docs in box
* add api reference for pipelines
* copied latest version to v0.6.0
* Remove space
* Remove space
* Copy to v0.6.0
Co-authored-by: brandenchan <brandenchan@icloud.com>
* Add languages and preprocessing pages
* add content
* address review comments
* make link relative
* update api ref with latest docstrings
* move doc readme and update
* add generator API docs
* fix example code
* design and link fix
Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai>
Co-authored-by: PiffPaffM <markuspaff.mp@gmail.com>
* 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>
