pyvesync/mkdocs.yml at dev · webdjoe/pyvesync · 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
129
site_name: "pyvesync"
site_url: https://pyvesync.github.io/
repo_name: webdjoe/pyvesync
repo_url: https://github.com/webdjoe/pyvesync

theme:
  name: material
  locale: en
  icon:
    logo: fontawesome/solid/house-signal
  highlightjs: true
  palette:
    scheme: slate
    primary: blue grey
    accent: blue
  show_bases: true
  features:
    - search.suggest
    - navigation.indexes
    - search.highlight
    - toc.follow
    - navigation.top

nav:
- Home: index.md
- Supported Devices: supported_devices.md
- pyvesync V3: pyvesync3.md
- Usage: usage.md
- Authentication: authentication.md
- Development:
    - development/index.md
    - VeSync API: development/vesync_api.md
    - Authentication: development/auth_api.md
    - Data Models: development/data_models.md
    - DeviceMap: development/device_map.md
    - DeviceContainer: development/device_container.md
    - VeSyncDevice Base: development/vesync_device_base.md
    - Constants: development/constants.md
    - Contributing: development/contributing.md
    - Capturing: development/capturing.md
    - Testing: development/testing.md
    - Utils:
      - Helpers: development/utils/helpers.md
      - Colors: development/utils/colors.md
      - Device Mixins: development/utils/device_mixins.md
      - Errors & Exceptions: development/utils/errors.md
      - Logging: development/utils/logging.md
- Devices:
    - devices/index.md
    - Outlets: devices/outlets.md
    - Switches: devices/switches.md
    - Bulbs: devices/bulbs.md
    - Air Purifiers: devices/air_purifiers.md
    - Humidifiers: devices/humidifiers.md
    - Fans: devices/fans.md
    - Air Fryers: devices/kitchen.md
    - Thermostats: devices/thermostats.md

markdown_extensions:
  - def_list
  - toc:
      permalink: ↲
      permalink_class: toc-permalink
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      baselevel: 1
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.fancylists
  - pymdownx.saneheaders
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
  - attr_list

# hooks:
# - docs/hooks.py

watch:
- src/pyvesync

extra_css:
  - stylesheets/common.css

extra:
  version:
    provider: mike
    default: latest
    alias: true

plugins:
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      deploy_prefix: ''
      canonical_version: latest
      version_selector: true
  # - git-revision-date-localized:
  #     enable_creation_date: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["src/"]
          options:
            show_submodules: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            extensions:
            - griffe_warnings_deprecated:
              kind: danger
              title: Deprecated
              label: "deprecated"
            - griffe_inherited_docstrings:
              merge: true
            - docstring_inheritance.griffe
            - scripts/docs_handler.py:InheritedNotation

  - search
  - autorefs:
      resolve_closest: true
  - include-markdown:
      preserve_includer_indent: false
      dedent: true