DeUX/mkdocs.yml at main · graphras-com/DeUX · 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
site_name: DeUX
site_description: A high-level, asyncio-native Python library for Elgato Stream Deck devices.
repo_url: https://github.com/graphras-com/DeUX

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Guides:
      - DUI Repository & Built-in Packages: guides/dui-repository.md
      - Creating DUI Packages: guides/creating-dui-packages.md
      - Theming: guides/theming.md
      - Error Handling: guides/error-handling.md
      - Full-Screen Images: guides/full-screen-images.md
      - CLI Tools: guides/cli-tools.md
  - Example: example.md
  - Style Guide: STYLE.md
  - API Reference: reference/

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_diagrams.py
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: numpy
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true