pyredis/mkdocs.yml at main · schlitzered/pyredis · 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
site_name: pyredis
theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
    - scheme: slate
      primary: indigo
      accent: indigo
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - toc.integrate

nav:
  - Introduction: index.md
  - Usage Example: example.md
  - API Reference:
      - Connection:
          - Connection: api/connection/connection.md
          - AsyncConnection: api/connection/async_connection.md
      - Clients:
          - Client: api/client/client.md
          - AsyncClient: api/client/async_client.md
          - ClusterClient: api/client/cluster_client.md
          - AsyncClusterClient: api/client/async_cluster_client.md
          - HashClient: api/client/hash_client.md
          - AsyncHashClient: api/client/async_hash_client.md
          - PubSubClient: api/client/pubsub_client.md
          - AsyncPubSubClient: api/client/async_pubsub_client.md
          - SentinelClient: api/client/sentinel_client.md
          - AsyncSentinelClient: api/client/async_sentinel_client.md
      - Pools:
          - BasePool: api/pool/base_pool.md
          - AsyncBasePool: api/pool/async_base_pool.md
          - Pool: api/pool/pool.md
          - AsyncPool: api/pool/async_pool.md
          - ClusterPool: api/pool/cluster_pool.md
          - AsyncClusterPool: api/pool/async_cluster_pool.md
          - HashPool: api/pool/hash_pool.md
          - AsyncHashPool: api/pool/async_hash_pool.md
          - SentinelPool: api/pool/sentinel_pool.md
          - AsyncSentinelPool: api/pool/async_sentinel_pool.md
          - SentinelHashPool: api/pool/sentinel_hash_pool.md
          - AsyncSentinelHashPool: api/pool/async_sentinel_hash_pool.md
      - Commands:
          - Connection: api/commands/connection.md
          - Hash: api/commands/hash.md
          - HyperLogLog: api/commands/hyperloglog.md
          - Geo: api/commands/geo.md
          - Key: api/commands/key.md
          - List: api/commands/list.md
          - Publish: api/commands/publish.md
          - Scripting: api/commands/scripting.md
          - Set: api/commands/set.md
          - SSet: api/commands/sset.md
          - String: api/commands/string.md
          - Subscribe: api/commands/subscribe.md
          - Transaction: api/commands/transaction.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            inherited_members: true
            show_if_no_docstring: true

markdown_extensions:
  - admonition
  - codehilite
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra_javascript:
  - https://unpkg.com/mermaid/dist/mermaid.min.js