frequenz-microgrid 0.2.2

A high-level interface to the Frequenz Microgrid API.
Documentation 
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
130
131

# MkDocs configuration
# For details see: https://www.mkdocs.org/user-guide/configuration/

# Project information
site_name: "Frequenz Microgrid API"
site_description: "Frequenz gRPC API for monitoring and control of microgrids"
site_author: "Frequenz Energy-as-a-Service GmbH"
copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
repo_name: "frequenz-api-microgrid"
repo_url: "https://github.com/frequenz-floss/frequenz-api-microgrid"
edit_uri: "edit/v0.x.x/docs/"
strict: true  # Treat warnings as errors

# Build directories
theme:
  name: "material"
  logo: _img/logo.png
  favicon: _img/logo.png
  language: en
  icon:
    edit: material/file-edit-outline
    repo: fontawesome/brands/github
  custom_dir: docs/overrides
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.footer
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - toc.follow
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: deep purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: teal
    toggle:
      icon: material/weather-night
      name: Switch to light mode

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/frequenz-floss
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/frequenz-com
  version:
    provider: mike
    default: latest

extra_css:
  - _css/style.css
  - _css/mkdocstrings.css

# Formatting options
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.keys
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: "¤"

plugins:
  - gen-files:
      scripts:
        - docs/_scripts/mkdocstrings_autoapi.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mike:
      alias_type: symlink
      canonical_version: latest
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            paths: ["py"]
            docstring_section_style: spacy
            inherited_members: true
            merge_init_into_class: false
            separate_signature: true
            show_category_heading: true
            show_root_heading: true
            show_root_members_full_path: true
            show_signature_annotations: true
            show_source: true
            show_symbol_type_toc: true
            signature_crossrefs: true
          import:
            # See https://mkdocstrings.github.io/python/usage/#import for details
            - https://docs.python.org/3/objects.inv
            - https://frequenz-floss.github.io/frequenz-api-common/v0.6/objects.inv
            - https://grpc.github.io/grpc/python/objects.inv
            - https://typing-extensions.readthedocs.io/en/stable/objects.inv
  - macros:
      modules: ["frequenz.repo.config.mkdocs.mkdocstrings_macros"]
      on_undefined: strict
      on_error_fail: true
  - search

# Preview controls
watch:
  - "py"
  - README.md
  - CONTRIBUTING.md