docs: Temporarily mark RF calibration chapter as ESP32 only

Can be re-enabled once ESP32-S2 calibration support is added
This commit is contained in:
Angus Gratton 2020-01-31 17:16:03 +11:00 committed by Angus Gratton
parent 4bfd004c83
commit eb85cfb9f6
4 changed files with 5 additions and 3 deletions

View File

@ -308,7 +308,8 @@ endmenu # Wi-Fi
menu "PHY"
config ESP32_PHY_CALIBRATION_AND_DATA_STORAGE
# ToDo: remove once NVS and PHY partial calibration are supported
# ToDo: remove target dependency once NVS and PHY partial calibration are supported
# also re-enable the <RF_calibration> entry in docs/../api-guides/index.rst
depends on IDF_TARGET_ESP32
bool "Store phy calibration data in NVS"
default y

View File

@ -132,6 +132,7 @@ def update_exclude_patterns(tags):
for e in ['api-guides/blufi.rst',
'api-guides/build-system-legacy.rst',
'api-guides/esp-ble-mesh/**',
'api-guides/RF_calibration.rst', # temporary until support re-added in esp_wifi
'api-guides/ulp-legacy.rst',
'api-guides/unit-tests-legacy.rst',
'api-guides/ulp_instruction_set.rst',

View File

@ -27,7 +27,7 @@ API Guides
Linker Script Generation <linker-script-generation>
lwIP TCP/IP Stack <lwip>
Partition Tables <partition-tables>
RF Calibration <RF_calibration>
:esp32: RF Calibration <RF_calibration>
ROM debug console <romconsole>
Secure Boot <../security/secure-boot>
Thread Local Storage <thread-local-storage>

View File

@ -28,7 +28,7 @@ API 指南
应用层跟踪 <app_trace>
控制台终端组件 <console>
ROM debug console <romconsole>
RF Calibration <RF_calibration>
:esp32: RF Calibration <RF_calibration>
WiFi Driver <wifi>
:esp32: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
ESP-MESH (Wi-Fi) <mesh>