api-docs/mkdocs.yml at main · waldur/api-docs · 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
site_name: Waldur API Documentation
site_url: https://docs.waldur.com/
site_description: API reference and SDK documentation for Waldur cloud management platform. See the latest version at https://docs.waldur.com
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - toc.follow
    - versioning
  palette:
    # Palette toggle for light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  analytics:
    gtag: G-5M7QPTQT8H
  logo: assets/waldur-logo.svg
  favicon: assets/waldur-logo.svg
extra:
  version:
    provider: mike

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - def_list
  - pymdownx.details
  - pymdownx.highlight:
      linenums: true
  - pymdownx.superfences:
      custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - awesome-pages
  - git-revision-date
  - include-markdown
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: latest
      version_selector: true
      css_dir: css
      javascript_dir: js
  - print-site:
      print_page_title: 'Print documentation'
      enumerate_headings: true
      add_to_navigation: false
      add_cover_page: true
      exclude:
        - API/
        - API/*

copyright: Copyright &copy; 2016 - 2025 Waldur team