quivr/backend/docs/mkdocs.yml
AmineDiro 90848eb827
docs: quivr core storage (#3366)
# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

---------

Co-authored-by: aminediro <aminedirhoussi@gmail.com>
Co-authored-by: Jacopo Chevallard <jacopo.chevallard@mailfence.com>
Co-authored-by: chloedia <chloedaems0@gmail.com>
2024-10-14 01:31:00 -07:00

91 lines
2.1 KiB
YAML

site_name: Quivr
extra_css:
- css/style.css
markdown_extensions:
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences
- md_in_html
- toc:
permalink: "#"
theme:
custom_dir: overrides
features:
- navigation.instant
- navigation.tabs
- navigation.indexes
- navigation.top
- navigation.footer
- toc.follow
- content.code.copy
- search.suggest
- search.highlight
name: material
palette:
- media: (prefers-color-scheme)
toggle:
icon: material/brightness-auto
name: Switch to light mode
- accent: purple
media: "(prefers-color-scheme: light)"
primary: white
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- accent: purple
media: "(prefers-color-scheme: dark)"
primary: black
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
plugins:
- mkdocstrings:
default_handler: python
handlers:
python:
docstring_style: google
options:
show_source: false
heading_level: 2
separate_signature: true
nav:
- Home:
- index.md
- installation.md
- Brain:
- brain/index.md
- brain/brain.md
- brain/chat.md
- Storage:
- storage/index.md
- storage/base.md
- storage/local_storage.md
- Parsers:
- parsers/index.md
- parsers/megaparse.md
- parsers/simple.md
- Vector Stores:
- vectorstores/index.md
- vectorstores/faiss.md
- vectorstores/pgvector.md
- Workflows:
- workflows/index.md
- Examples:
- workflows/examples/chat.md
- workflows/examples/rag_with_internet.md
- Configuration:
- config/index.md
- config/base_config.md
- config/config.md
- Examples:
- examples/index.md
- examples/custom_storage.md
- Enterprise: https://docs.quivr.app/