py-cachify/mkdocs.yml at main · EzyGang/py-cachify · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
site_name: Py-Cachify
site_description: Py-Cachify. Cache and locks made easy. Fully type annotated. 100% coverage.
repo_name: EzyGang/py-cachify
repo_url: https://github.com/EzyGang/py-cachify

theme:
  name: material
  logo: img/logo-icon.svg
  favicon: img/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: cyan
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

markdown_extensions:
  # Python Markdown
  abbr:
  attr_list:
  footnotes:
  md_in_html:
  tables:
  toc:
    permalink: true

  # Python Markdown Extensions
  pymdownx.betterem:
    smart_enable: all
  pymdownx.caret:
  pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
  pymdownx.inlinehilite:
  pymdownx.snippets:
  pymdownx.keys:
  pymdownx.mark:
  pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.tilde:

  # pymdownx blocks
  pymdownx.blocks.admonition:
    types:
      - note
      - attention
      - caution
      - danger
      - error
      - tip
      - hint
      - warning
      # Custom types
      - info
  pymdownx.blocks.details:
  pymdownx.blocks.tab:
    alternate_style: True

plugins:
  # Material for MkDocs
  - search
  - termynal
  - include-markdown
nav:
  - Introduction: "index.md"
  - Tutorial - User Guide:
      - tutorial/index.md
      - Initial setup:
          - tutorial/initial-setup/install.md
          - tutorial/initial-setup/initialization.md
      - Cached (///@cached()/// decorator):
          - tutorial/cached-decorator/first-steps.md
          - tutorial/cached-decorator/dynamic-cache-keys.md
          - tutorial/cached-decorator/specifying-ttl-and-encoder-decoder.md
          - Cached - Manually resetting cache with ///reset()/// method: tutorial/cached-decorator/reset-attribute.md
      - Lock (///lock()/// context manager and decorator):
          - tutorial/locks/locks-intro.md
          - tutorial/locks/simple-locks.md
          - tutorial/locks/lock-parameters.md
          - tutorial/locks/lock-methods.md
          - tutorial/locks/lock-as-decorator.md
      - Once (///@once()/// decorator):
          - tutorial/once-decorator/index.md
      - Pools (///pool()/// and ///@pooled()///):
          - tutorial/pools/pools-intro.md
          - tutorial/pools/simple-pools.md
          - tutorial/pools/pool-parameters.md
          - tutorial/pools/pool-methods.md
          - tutorial/pools/pooled-decorator.md
  - API Reference:
      - reference/init.md
      - reference/cached.md
      - reference/lock.md
      - reference/once.md
      - reference/pool.md
  - Examples: examples.md
  - Contribution & Help:
      - help/help.md
      - help/contribution.md
  - Release Notes: release-notes.md
  - LLM Full: llm-full.md

hooks:
  - docs/scripts/hooks.py