Skip to content

[packet_transport] Fix rst conversion issues #5509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: current
Choose a base branch
from
Open

[packet_transport] Fix rst conversion issues #5509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a597f3d
Fix rst conversion issues
swoboda1337 Oct 21, 2025
5d8fec8
Fix automation docrefs
swoboda1337 Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/components/packet_transport/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ binary_sensor:

- {{< docref "/components/binary_sensor/packet_transport" >}}
- {{< docref "/components/sensor/packet_transport" >}}
- [Automation](#automation)
- {{< docref "/automations" >}}
- {{< apiref "packet_transport/packet_transport.h" "packet_transport/packet_transport.h" >}}

[^f1]: As known in 2025.02.
10 changes: 4 additions & 6 deletions content/components/packet_transport/sx126x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ params:
image: sx126x.png
---

.. sx126x-packet-transport:

The [Packet Transport Component](#packet-transport) platform allows ESPHome nodes to directly communicate with each over a
The {{< docref "/components/packet_transport" >}} platform allows ESPHome nodes to directly communicate with each over a
communication channel. The {{< docref "/components/sx126x" >}} implementation of the platform uses FSK or
LoRa as a communication medium. See the [Packet Transport Component](#packet-transport) and [SX126x Component](#sx126x) for more information.
LoRa as a communication medium. See the {{< docref "/components/packet_transport" >}} and {{< docref "/components/sx126x" >}} for more information.

## Example Configuration

Expand Down Expand Up @@ -52,9 +50,9 @@ sensor:

## See Also

- [Packet Transport Component](#packet-transport)
- {{< docref "/components/packet_transport" >}}
- {{< docref "/components/sx126x" >}}
- {{< docref "/components/binary_sensor/packet_transport" >}}
- {{< docref "/components/sensor/packet_transport" >}}
- [Automation](#automation)
- {{< docref "/automations" >}}
- {{< apiref "packet_transport/packet_transport.h" "packet_transport/packet_transport.h" >}}
10 changes: 4 additions & 6 deletions content/components/packet_transport/sx127x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ params:
image: sx127x.png
---

.. sx127x-packet-transport:

The [Packet Transport Component](#packet-transport) platform allows ESPHome nodes to directly communicate with each over a
The {{< docref "/components/packet_transport" >}} platform allows ESPHome nodes to directly communicate with each over a
communication channel. The {{< docref "/components/sx127x" >}} implementation of the platform uses FSK, OOK or
LoRa as a communication medium. See the [Packet Transport Component](#packet-transport) and [SX127x Component](#sx127x) for more information.
LoRa as a communication medium. See the {{< docref "/components/packet_transport" >}} and {{< docref "/components/sx127x" >}} for more information.

## Example Configuration

Expand Down Expand Up @@ -48,9 +46,9 @@ sensor:

## See Also

- [Packet Transport Component](#packet-transport)
- {{< docref "/components/packet_transport" >}}
- {{< docref "/components/sx127x" >}}
- {{< docref "/components/binary_sensor/packet_transport" >}}
- {{< docref "/components/sensor/packet_transport" >}}
- [Automation](#automation)
- {{< docref "/automations" >}}
- {{< apiref "packet_transport/packet_transport.h" "packet_transport/packet_transport.h" >}}
8 changes: 4 additions & 4 deletions content/components/packet_transport/uart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ params:

{{< anchor "uart-packet-transport" >}}

The [Packet Transport Component](#packet-transport) platform allows ESPHome nodes to directly communicate with each over a communication channel.
The UART implementation of the platform uses a serial port as a communication medium. See the [Packet Transport Component](#packet-transport) and [UART Bus](#uart) for more information.
The {{< docref "/components/packet_transport" >}} platform allows ESPHome nodes to directly communicate with each over a communication channel.
The UART implementation of the platform uses a serial port as a communication medium. See the {{< docref "/components/packet_transport" >}} and {{< docref "/components/uart" >}} for more information.

## Example Configuration

Expand All @@ -37,9 +37,9 @@ sensor:

## See Also

- [Packet Transport Component](#packet-transport)
- {{< docref "/components/packet_transport" >}}
- {{< docref "/components/uart" >}}
- {{< docref "/components/binary_sensor/packet_transport" >}}
- {{< docref "/components/sensor/packet_transport" >}}
- [Automation](#automation)
- {{< docref "/automations" >}}
- {{< apiref "packet_transport/packet_transport.h" "packet_transport/packet_transport.h" >}}
8 changes: 4 additions & 4 deletions content/components/packet_transport/udp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ params:

{{< anchor "udp-packet-transport" >}}

The [Packet Transport Component](#packet-transport) platform allows ESPHome nodes to directly communicate with each over a communication channel.
The UDP implementation of the platform uses UDP as a communication medium. See the [Packet Transport Component](#packet-transport) and [UDP Component](#udp) for more information.
The {{< docref "/components/packet_transport" >}} platform allows ESPHome nodes to directly communicate with each over a communication channel.
The UDP implementation of the platform uses UDP as a communication medium. See the {{< docref "/components/packet_transport" >}} and {{< docref "/components/udp" >}} for more information.

## Example Configuration

Expand All @@ -34,9 +34,9 @@ sensor:

## See Also

- [Packet Transport Component](#packet-transport)
- {{< docref "/components/packet_transport" >}}
- {{< docref "/components/udp" >}}
- {{< docref "/components/binary_sensor/packet_transport" >}}
- {{< docref "/components/sensor/packet_transport" >}}
- [Automation](#automation)
- {{< docref "/automations" >}}
- {{< apiref "packet_transport/packet_transport.h" "packet_transport/packet_transport.h" >}}