remote-store/mkdocs.yml at master · haalfi/remote-store · 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
site_name: remote-store
site_url: https://docs.remotestore.dev/
site_description: Write file storage code once. Run it against local files, S3, SFTP, or Azure.
repo_url: https://github.com/haalfi/remote-store
repo_name: haalfi/remote-store

docs_dir: docs-src

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - toc.follow

plugins:
  - search
  - mike:
      version_selector: true
  - gen-files:
      scripts:
        - scripts/gen_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: list
            merge_init_into_class: true
            members_order: source
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_if_no_docstring: false
            heading_level: 2
            separate_signature: true
            signature_crossrefs: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets:
      base_path: ["."]
      dedent_subsections: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

extra:
  version:
    provider: mike

extra_css:
  - css/custom.css

validation:
  links:
    not_found: warn