redis-om-python/mkdocs.yml at main · redis/redis-om-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
site_name: Redis OM Python
site_description: Object mapping, and more, for Redis and Python.
site_url: https://redis.github.io/redis-om-python/
repo_url: https://github.com/redis/redis-om-python
repo_name: redis/redis-om-python
edit_uri: blob/main/docs

docs_dir: docs

theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.action.edit
    - content.action.view

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/redis/redis-om-python
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/redis-om/

nav:
  - Home: index.md
  - Getting Started:
      - Tutorial: getting_started.md
      - Redis Setup: redis_setup.md
  - User Guide:
      - Models: models.md
      - Making Queries: querying.md
      - Migrations: migrations.md
      - FastAPI Integration: fastapi_integration.md
  - Reference:
      - Errors: errors.md
      - Release Notes 1.0: release_notes_1.0.md
      - Release Notes 1.1: release_notes_1.1.md
      - Upgrade Guide (0.x → 1.x): migration_guide_0x_to_1x.md

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

copyright: |
  &copy; 2024 <a href="https://github.com/redis" target="_blank" rel="noopener">Redis</a>