file-keeper/mkdocs.yml at master · DataShades/file-keeper · 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
site_name: file-keeper
site_url: https://datashades.github.io/file-keeper/
repo_url:  https://github.com/DataShades/file-keeper

markdown_extensions:
  - abbr
  - attr_list
  - footnotes
  - tables
  - pymdownx.snippets
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details
  - pymdownx.blocks.tab:
          alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          # format: !!python/name:mermaid2.fence_mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - macros
  # - mermaid2
  - spellcheck:
      backends:
        - codespell
  - search:
      separator: '[\s\-\.\_]+'
  - mkdocstrings:
      handlers:
        python:
          paths: ["src/file_keeper"]
          options:
            show_root_full_path: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_source: false
            docstring_section_style: spacy

watch:
  - README.md
  - src/file_keeper

theme:
  name: material
  logo: img/logo.svg
  # favicon: img/favicon.ico
  palette:
    # Palette toggle for light mode
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-auto
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    - content.footnote.tooltips
nav:
  - index.md
  - Tutorials:
    - tutorials/getting_started.md
    - tutorials/advanced_patterns.md
  - Examples:
    - examples/README.md
    - examples/web_app/README.md
    - examples/file_migration/README.md
    - examples/batch_processing/README.md
    - examples/custom_adapter/README.md
  - Configuration:
    - configuration.md
  - Storage adapters:
    - adapters/emulate.md
    - adapters/libcloud.md
    - adapters/opendal.md
    - adapters/s3.md
    - adapters/azure_blob.md
    - adapters/fsspec.md
    - adapters/gcs.md
    - adapters/fs.md
    - adapters/memory.md
    - adapters/null.md
    - adapters/obstore.md
    - adapters/redis.md
    - adapters/sqlalchemy.md
    - adapters/zip.md

  - Core concepts:
    - core_concepts/index.md
    - core_concepts/data_model.md
    - core_concepts/uploads.md
    - core_concepts/capabilities.md
  - Extending file-keeper:
      - extending/overview.md
      - extending/adapters.md
      - extending/location_transformers.md
      - extending/dissection.md

  - Reference:
    - faq.md
    - migration_guide.md
    - quick_reference.md
    - error_handling.md
    - api.md
    - testing.md
    - glossary.md
  - changelog.md