python-overkiz-api/mkdocs.yml at dae5e914fc5f16b72aa9dfa7239413059a3a6489 · iMicknl/python-overkiz-api · 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
site_name: pyOverkiz Documentation
repo_url: https://github.com/iMicknl/python-overkiz-api
edit_uri: edit/main/docs/

docs_dir: docs
copyright: This project is not affiliated with Overkiz, Somfy, or any other mentioned brand. All trademarks and brand names are the property of their respective owners.

extra:
  generator: false

theme:
  name: material
  features:
    - navigation.tabs
    - toc.follow
    - search.suggest
    - search.highlight
    - navigation.footer

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            docstring_style: google
            show_docstring_attributes: true
            show_signature: true
            show_signature_annotations: true
            signature_crossrefs: true

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tasklist
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Overview: index.md
  - User Guide:
      - Getting started: getting-started.md
      - Core concepts: core-concepts.md
      - Device control: device-control.md
      - Action queue: action-queue.md
      - Event handling: event-handling.md
      - Troubleshooting: troubleshooting.md
  - API Reference: api-reference.md
  - Contribute: contribute.md