Skip to content

Commit 74b9007

Browse files
authored
Fix glossary links and restrict mkdocs-autorefs updates (#1043)
2 parents 790f507 + 0716a93 commit 74b9007

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/user-guide/glossary.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ components](#component-category) together. It can be connected to the public
6161
[grid](#grid), or be completely isolated, in which case it is known as an
6262
island.
6363

64-
Components can be grouped into [assets](#Assets) and [devices](#Devices).
64+
Components can be grouped into [assets](#assets) and [devices](#devices).
6565
Assets are core components like generators or storage systems that are crucial from a business perspective,
6666
whereas devices are the supporting infrastructure essential for the functionality of these assets.
6767

@@ -188,8 +188,8 @@ microgrid are connected with each other. Some of the ways in which the SDK uses
188188
the component graph are:
189189

190190
- figure out how to calculate high level metrics like
191-
[`grid_power`][frequenz.sdk.timeseries.grid.Grid.power],
192-
[`consumer_power`][frequenz.sdk.timeseries.consumer.Consumer.power],
191+
[`grid().power`][frequenz.sdk.timeseries.grid.Grid.power],
192+
[`consumer().power`][frequenz.sdk.timeseries.consumer.Consumer.power],
193193
etc. for a microgrid, using the available components.
194194
- identify the available {{glossary("battery", "batteries")}} or
195195
{{glossary("EV charger", "EV chargers")}} at a site that can be controlled.
@@ -408,7 +408,8 @@ flowing into the component instead, this will be zero.
408408

409409
In [microgrid](#microgrid) context sometimes used as the remaining difference
410410
between the [net consumption](#net-consumption) and the [battery](#battery)
411-
power, i.e. what we define as [grid power](#grid_power).
411+
power, i.e. what we define as
412+
[`grid().power`][frequenz.sdk.timeseries.grid.Grid.power].
412413

413414
### Residual Load
414415

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ dev-mkdocs = [
5454
"black == 24.4.2",
5555
"Markdown==3.6",
5656
"mike == 2.1.2",
57+
"mkdocs-autorefs >= 1.0.1, < 1.1",
5758
"mkdocs-gen-files == 0.5.0",
5859
"mkdocs-literate-nav == 0.6.1",
5960
"mkdocs-macros-plugin == 1.0.5",

0 commit comments

Comments
 (0)