PySpaceMouse/mkdocs.yml at master · JakubAndrysek/PySpaceMouse · 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
site_name: PySpaceMouse
site_url: https://jakubandrysek.github.io/pyspacemouse/
site_author: Jakub Andrýsek
site_description: >-
    PySpaceMouse is a Python library for 3DConnexion SpaceMouse devices.
    The library is cross-platform and works on Linux, Windows and macOS.

# Repository
repo_name: JakubAndrysek/pyspacemouse/
repo_url: https://github.com/JakubAndrysek/pyspacemouse/

# Copyright
copyright: Copyright © 2023 Jakub Andrýsek

theme:
  name: material
  language: en
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - content.action.edit
    - content.action.view
    - navigation.tracking
    - navigation.tabs
    - navigation.expand
  icon:
    repo: fontawesome/brands/github

  palette:
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/JakubAndrysek
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/KubaAndrysek
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/jakub-andrysek/
  analytics:
      provider: google
      property: G-P82VYYEZW9

use_directory_urls: True
#use_directory_urls: False

plugins:
  - search
  - glightbox
  - open-in-new-tab
  - mkdoxy:
      projects:
        mouseApi:
          src-dirs: pyspacemouse
          full-doc: True
          doxy-cfg:
            FILE_PATTERNS: "*.py"
            EXAMPLE_PATH: ""
            RECURSIVE: True
            OPTIMIZE_OUTPUT_JAVA: True
            JAVADOC_AUTOBRIEF: True
            EXTRACT_ALL: True
      save-api: .mkdoxy
      full-doc: True
      debug: False
      ignore-errors: False

  - git-revision-date-localized


markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list

nav:
  - Home: 'README.md'
  - Contributing: 'CONTRIBUTING.md'
  - Troubleshooting: 'troubleshooting.md'

  - API:
      - mouseApi/index.md
      - 'Examples': 'mouseApi/examples.md'
      - 'Links': 'mouseApi/links.md'
      - 'Classes':
          - 'Class List': 'mouseApi/annotated.md'
          - 'Class Index': 'mouseApi/classes.md'
          - 'Class Hierarchy': 'mouseApi/hierarchy.md'
          - 'Class Members': 'mouseApi/class_members.md'
          - 'Class Member Functions': 'mouseApi/class_member_functions.md'
          - 'Class Member Variables': 'mouseApi/class_member_variables.md'
          - 'Class Member Typedefs': 'mouseApi/class_member_typedefs.md'
          - 'Class Member Enumerations': 'mouseApi/class_member_enums.md'
      - 'Namespaces':
          - 'Namespace List': 'mouseApi/namespaces.md'
          - 'Namespace Members': 'mouseApi/namespace_members.md'
          - 'Namespace Member Functions': 'mouseApi/namespace_member_functions.md'
          - 'Namespace Member Variables': 'mouseApi/namespace_member_variables.md'
          - 'Namespace Member Typedefs': 'mouseApi/namespace_member_typedefs.md'
          - 'Namespace Member Enumerations': 'mouseApi/namespace_member_enums.md'
      - 'Functions': 'mouseApi/functions.md'
      - 'Variables': 'mouseApi/variables.md'
      - 'Macros': 'mouseApi/macros.md'
      - 'Files': 'mouseApi/files.md'