QField/mkdocs.yml at master · tw0b33rs/QField · 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
site_name: "QField API Documentation"

theme:
  name: material
  logo: assets/images/qfield_logo_white.svg
  favicon: assets/images/favicon.ico
  palette:
    - scheme: default
      primary: light green
      toggle:
        icon: octicons/moon-24
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      toggle:
        icon: octicons/sun-24
        name: Switch to light mode

copyright: Copyright &copy; 2023 <a href="https://OPENGIS.ch">OPENGIS.ch</a> -  <a
  href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank">CC-BY-SA
  4.0</a>

plugins:
  - search
  - mkdoxy:
      projects:
        QField:
          src-dirs: ./src/
          full-doc: True
          doxy-cfg:
            EXTENSION_MAPPING: "qml=C++"
            FILTER_PATTERNS: "*.qml=doxyqml"
            FILE_PATTERNS: "*.cpp *.h* *.qml"
            RECURSIVE: True
            SHOW_FILES: False

nav:
  - Home: index.md
  - Code Snippets: snippets.md
  - Translate a plugin: translate.md
  - C++ app classes: QField/group__app.md
  - C++ core classes: QField/group__core.md
  - C++ gui classes: QField/group__gui.md
  - C++ 3D classes: QField/group____3d.md
  - QML app items: QField/group__qml__app.md
  - QML core items: QField/group__qml__core.md
  - QML gui items: QField/group__qml__gui.md
  - QML 3D items: QField/group__qml__3d.md

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences