react-squirrel-backend/mkdocs.yml at main · slaclab/react-squirrel-backend · 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
# Project Information
site_name: Squirrel Backend
site_url: https://slaclab.github.io/react-squirrel-backend/
site_author: SLAC National Accelerator Laboratory - EED / Software Applications Group
site_description: High-performance Python FastAPI backend for EPICS snapshot/restore operations.

# Repository
repo_name: slaclab/react-squirrel-backend
repo_url: https://github.com/slaclab/react-squirrel-backend

# Configuration
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.top
    - navigation.tabs
    - navigation.indexes
    - navigation.footer
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            members_order: source
            show_root_toc_entry: false
            show_symbol_type_toc: true
            show_source: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
  - git-revision-date-localized:
      exclude:
        - index.md
      enable_creation_date: true
      fallback_to_build_date: true
  - git-committers:
      exclude:
        - index.md
      repository: slaclab/react-squirrel-backend
      branch: main

# Additional Configuration
extra:
  generator: false

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - images/
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables

# Page Tree
nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - API Keys: getting-started/api-keys.md
  - Architecture:
    - architecture/index.md
    - Distributed System: architecture/distributed-system.md
    - Data Flow: architecture/data-flow.md
  - Development:
    - development/index.md
    - Testing: development/testing.md
    - Database Migrations: development/migrations.md
    - Code Quality: development/code-quality.md
  - API Reference:
    - api-reference/index.md
    - REST Endpoints: api-reference/endpoints.md
    - WebSocket: api-reference/websocket.md
  - Python Reference:
    - reference/index.md