qtframelesskit/mkdocs.yml at main · BugCodeX/qtframelesskit · 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
site_name: QtFramelessKit
site_description: "Modern, cross-Qt frameless window framework for Windows in pure Python."
site_url: https://qtframelesskit.readthedocs.io/
repo_url: https://github.com/BugCodeX/qtframelesskit
repo_name: BugCodeX/qtframelesskit

theme:
  name: material
  logo: images/logo.png
  favicon: images/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            show_root_heading: true
            show_source: true
            heading_level: 2

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Guides:
      - Window Types: guides/windows.md
      - Title Bar & MenuBar: guides/titlebar.md
      - Materials & Styling: guides/styling.md
  - Concepts:
      - Architecture: concepts/architecture.md
      - Snap Layouts: concepts/snap-layouts.md
  - API Reference:
      - Windows: api/windows.md
      - Title Bar: api/titlebar.md
      - Core & Native: api/core.md