Fast-Cache/mkdocs.yml at main · devbijay/Fast-Cache · 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
109
110
111
112
113
114
115
116
117
site_name: FastAPI CacheKit
repo_url: https://github.com/devbijay/Fast-Cache
edit_uri: edit/main/docs/
repo_name: FastAPI CacheKit
site_url: https://devbijay.github.io/Fast-Cache
theme:
  name: material
  icon:
    repo: fontawesome/brands/github

  features:
    - navigation.instant
    - navigation.path
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.tracking
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.action.view
    - content.footnote.tooltips
    - toc.follow

  font:
    text: Roboto

  palette:
    - scheme: default
      primary: indigo
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

nav:
  - Home: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Backends:
      - Overview: backends.md
      - In-Memory: backends/in_memory.md
      - Redis: backends/redis.md
      - Postgres: backends/postgres.md
      - Memcached: backends/memcached.md
      - MongoDB: backends/mongodb.md
      - FireStore: backends/firestore.md
      - DynamoDB: backends/dynamodb.md
  - API Reference: api.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devbijay/Fast-Cache
      name: GitHub
  announcement:
    type: info
    text: "⭐️ Star FastAPI CacheKit on [GitHub](https://github.com/devbijay/Fast-Cache)!"
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
      pipeline:
        - stemmer
        - stopWordFilter
  - mkdocstrings:
      handlers:
        python:
          options:
            merge_init_into_class: true
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            unwrap_annotated: true
            members_order: source
            docstring_style: google
            show_source: true
            show_signature: true
            show_root_heading: true
            show_inheritance_diagram: true
            show_if_no_docstring: true
            extra:
              follow_wrapped: true