kvdb-py/mkdocs.yaml at main · trisongz/kvdb-py · 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
site_name: KVDB
repo_name: trisongz/kvdb-py
repo_url: https://github.com/trisongz/kvdb-py

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight

plugins:
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          load_external_modules: true
          paths:
            - .
          options:
            annotations_path: full
            docstring_section_style: spacy
            show_source: true
            allow_inspection: true
            inherited_members: true
            separate_signature: true
            signature_crossrefs: true
            unwrap_annotated: true
            merge_init_into_class: true
            show_signature: true
            show_signature_annotations: true
            summary: true
            heading_level: 3
            # filters:
            # - "!^_"
            # - "^__init__$"
            # preload_modules:
            # - redis


# https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/handler/?h=signat#mkdocstrings_handlers.python.handler.PythonHandler.default_config

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

nav:
  - index.md
  - Session Manager:
    - topics/session-manager.md
    - API Reference:
      - api/session-manager/api.md
  - Sessions:
    - topics/sessions.md
    - API Reference:
      - api/sessions/api.md
  - Serialization:
    - topics/serialization.md
    - Supported:
      - api/serializers/json.md
      - api/serializers/msgpack.md
      - api/serializers/pickle.md
  - Cachify:
    - topics/cachify.md
    - API Reference:
      - api/cachify/api.md
      - api/cachify/context-manager.md
      - api/cachify/context.md
      - api/cachify/object.md
  # - Examples:
  #     - examples/README.md
  #     - examples/queue/README.md
  #     # - examples/queue/client_side.py
  #     - examples/sessions/README.md
  #     - examples/caching/README.md
  #     # - examples/cache/basic.py
  #     # - examples/cache/objects.py
  #     # - examples/cache/context.py