Add documentation for enable_ipv6 flag. (#1749)

Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
This commit is contained in:
Jimmy Hedman 2022-01-25 10:00:09 +01:00 committed by GitHub
parent 89c2c47e47
commit 52e5273892
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 25 additions and 0 deletions

View File

@ -150,6 +150,7 @@ Configuration for Wireless Tag WT32-ETH01
See Also See Also
-------- --------
- :doc:`network`
- :apiref:`ethernet/ethernet_component.h` - :apiref:`ethernet/ethernet_component.h`
- `ESP32 Ethernet PHY connection info <https://pcbartists.com/design/embedded/esp32-ethernet-phy-schematic-design/>`__ - `ESP32 Ethernet PHY connection info <https://pcbartists.com/design/embedded/esp32-ethernet-phy-schematic-design/>`__
- :ghedit:`Edit` - :ghedit:`Edit`

22
components/network.rst Normal file
View File

@ -0,0 +1,22 @@
Network component
=================
.. seo::
:description:
:image: network-wifi.svg
:keywords: Network, WiFi, WLAN, Ethernet, ESP32
The network component is a global configuration for all types of
networks (WiFi, Ethernet).
.. code-block:: yaml
# Example configuration
network:
enable_ipv6: true
Configuration variables:
------------------------
- **enable_ipv6** (*Optional*, boolean): Enables IPv6 support. Defaults to ``false``. Only available on ESP32 with ESP-IDF framework.

View File

@ -269,5 +269,6 @@ See Also
-------- --------
- :doc:`captive_portal` - :doc:`captive_portal`
- :doc:`network`
- :apiref:`wifi/wifi_component.h` - :apiref:`wifi/wifi_component.h`
- :ghedit:`Edit` - :ghedit:`Edit`

View File

@ -142,6 +142,7 @@ Core Components
Core, components/esphome, cloud-circle.svg Core, components/esphome, cloud-circle.svg
WiFi, components/wifi, network-wifi.svg WiFi, components/wifi, network-wifi.svg
MQTT, components/mqtt, mqtt.png MQTT, components/mqtt, mqtt.png
Network, components/network, network-wifi.svg
I²C Bus, components/i2c, i2c.svg I²C Bus, components/i2c, i2c.svg
SPI Bus, components/spi, spi.svg SPI Bus, components/spi, spi.svg