Skip to content

Commit 973b540

Browse files
committed
docs: Fixed broken links
1 parent bf5518c commit 973b540

File tree

6 files changed

+12
-11
lines changed

6 files changed

+12
-11
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
restore-keys: |
3636
mkdocs-material-
3737
- run: pip install -r requirements.txt
38-
- run: mkdocs build
38+
- run: mkdocs build --strict
3939

4040
deploy_docs:
4141
if: ${{ github.repository_owner == 'BottlecapDave' && (github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main') }}

_docs/entities/electricity.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ If current consumption data is unable to be retrieved, then the integration will
428428
`sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_current_demand`
429429

430430
!!! warning
431-
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
431+
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
432432

433433
The current demand reported by the Home Mini/Pro. This will try and update every minute for Home Mini and every 10 seconds for Home Pro.
434434

@@ -470,7 +470,7 @@ Each charge item has the following attributes
470470
`sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_current_total_consumption`
471471

472472
!!! warning
473-
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
473+
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
474474

475475
!!! info
476476
An export equivalent of this sensor does not exist because the data is not available
@@ -563,7 +563,7 @@ The total cost reported by the meter for the current day during off peak hours (
563563
This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them).
564564

565565
!!! warning
566-
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
566+
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
567567

568568
!!! warning
569569

@@ -588,7 +588,7 @@ The total cost reported by the meter for the current day during standard hours (
588588
This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them).
589589

590590
!!! warning
591-
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
591+
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
592592

593593
!!! info
594594
An export equivalent of this sensor does not exist because the data is not available
@@ -609,7 +609,7 @@ The total cost reported by the meter for the current day during peak hours (the
609609
This is [disabled by default](../faq.md#there-are-entities-that-are-disabled-why-are-they-disabled-and-how-do-i-enable-them).
610610

611611
!!! warning
612-
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
612+
This will only be available if you have specified you have a [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
613613

614614
!!! info
615615
An export equivalent of this sensor does not exist because the data is not available

_docs/entities/gas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Each charge item has the following attributes
347347
`sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_current_total_consumption_m3`
348348

349349
!!! warning
350-
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
350+
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
351351

352352
The total consumption reported by the meter for for all time in m3. This is calculated/estimated using your set [calorific value](../setup/account.md#calorific-value) from the kWh data reported by Octopus Energy. This will try and update every minute for Home Mini and every 10 seconds for Home Pro.
353353

@@ -370,7 +370,7 @@ The total consumption reported by the meter for for all time in m3. This is calc
370370
`sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_current_total_consumption_kwh`
371371

372372
!!! warning
373-
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro). Do not set unless you have one.
373+
This will only be available if you have specified you have an [Octopus Home Mini](../setup/account.md#home-mini) or have configured an [Octopus Home Pro](../setup//account.md#home-pro-settings). Do not set unless you have one.
374374

375375
The total consumption reported by the meter for for all time in kWh. This is natively reported by Octopus Energy. This will try and update every minute for Home Mini and every 10 seconds for Home Pro.
376376

_docs/entities/home_pro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ Once configured, the following entities will retrieve data locally from your Oct
1515

1616
!!! info
1717

18-
This is only available if you have setup the [Custom API](../setup/account.md#home-pro).
18+
This is only available if you have setup the [Custom API](../setup/account.md#home-pro-settings).
1919

2020
Allows you to set scrolling text on the home pro device. If the text is greater than 3 characters, then it will scroll on the device, otherwise it will be statically displayed.

_docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blo
6262

6363
### Home Pro
6464

65-
If you are lucky enough to own an [Octopus Home Pro](https://forum.octopus.energy/t/for-the-pro-user/8453/2352/) (note that is is no longer possible to obtain one), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to configure your [Home Pro](./setup/account.md#home-pro). This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
65+
If you are lucky enough to own an [Octopus Home Pro](https://forum.octopus.energy/t/for-the-pro-user/8453/2352/) (note that is is no longer possible to obtain one), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to configure your [Home Pro](./setup/account.md#home-pro-settings). This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
6666

6767
!!! info
6868

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"release": "semantic-release",
1010
"test-unit": "python -m pytest tests/unit",
1111
"test-integration": "python -m pytest tests/integration",
12-
"docs-serve": "python -m mkdocs serve"
12+
"docs-serve": "python -m mkdocs serve",
13+
"docs-build": "python -m mkdocs build --strict"
1314
},
1415
"repository": {
1516
"type": "git",

0 commit comments

Comments
 (0)