PyGlobe/mkdocs.yml at main · bthcode/PyGlobe · 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
site_name: PyGlobe
site_description: PySide6 ObenGL Globe Widget
site_author: Bran Hone

nav:
  - Home: 'index.md'
  - Code Overview: 'code-overview.md'
  - API Reference: 'api-reference.md'
  - Coordinate Reference: 'coords.md'
#  - User Guide: 'user-guide.md'
#  - About: 'about.md'

theme:
  name: readthedocs # Or 'readthedocs', 'mkdocs', etc.
  palette:
    - scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.tabs.link

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

plugins:
- search
- mkdocstrings
- mermaid2