Merge branch 'bugfix/esp32s2beta_docs' into 'feature/esp32s2beta'

esp32s2beta: Fix docs build

See merge request espressif/esp-idf!6096

components/driver/esp32s2beta/include/temp_sensor.h

@@ -31,6 +31,9 @@ typedef enum {
     TSENS_DAC_DEFAULT = TSENS_DAC_L2,
 } temp_sensor_dac_offset_t;
 
+/**
+ * @brief Configuration for temperature sensor reading
+ */
 typedef struct {
     temp_sensor_dac_offset_t dac_offset;    /*!< The temperature measurement range is configured with a built-in temperature offset DAC. */
     uint8_t clk_div;                        /*!< Default: 6 */
@@ -93,4 +96,4 @@ esp_err_t temp_sensor_read_celsius(float *celsius);
 
 #ifdef __cplusplus
 }
-#endif
+#endif

components/driver/include/driver/i2c.h

@@ -89,11 +89,11 @@ typedef struct{
     union {
         struct {
             uint32_t clk_speed;     /*!< I2C clock frequency for master mode, (no higher than 1MHz for now) */
-        } master;
+        } master; /*!< Configuration if the I2C peripheral is master */
         struct {
             uint8_t addr_10bit_en;  /*!< I2C 10bit address mode enable for slave mode */
             uint16_t slave_addr;    /*!< I2C address for slave mode */
-        } slave;
+        } slave; /*!< Configuration if the I2C peripheral is slave */
 
     };
 }i2c_config_t;

components/driver/include/driver/ledc.h

@@ -314,7 +314,6 @@ esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t
  * @param arg User-supplied argument passed to the handler function.
  * @param intr_alloc_flags Flags used to allocate the interrupt. One or multiple (ORred)
  *        ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info.
- * @param arg Parameter for handler function
  * @param handle Pointer to return handle. If non-NULL, a handle for the interrupt will
  *        be returned here.
  *

components/driver/include/driver/mcpwm.h

@@ -696,7 +696,6 @@ esp_err_t mcpwm_sync_disable(mcpwm_unit_t mcpwm_num, mcpwm_timer_t timer_num);
  * @param arg user-supplied argument passed to the handler function.
  * @param intr_alloc_flags flags used to allocate the interrupt. One or multiple (ORred)
  *        ESP_INTR_FLAG_* values. see esp_intr_alloc.h for more info.
- * @param arg parameter for handler function
  * @param handle pointer to return handle. If non-NULL, a handle for the interrupt will
  *        be returned here.
  *

docs/conf_common.py

@@ -95,6 +95,11 @@ kconfigs = find_component_files("../../components", "Kconfig")
 kconfig_projbuilds = find_component_files("../../components", "Kconfig.projbuild")
 sdkconfig_renames = find_component_files("../../components", "sdkconfig.rename")
 
+# trim the esp32s2beta component, until we have proper multi-target support
+kconfigs = [k for k in kconfigs if "esp32s2beta" not in k]
+kconfig_projbuilds = [k for k in kconfig_projbuilds if "esp32s2beta" not in k]
+sdkconfig_renames = [r for r in sdkconfig_renames if "esp32s2beta" not in r]
+
 confgen_args = [sys.executable,
                 "../../tools/kconfig_new/confgen.py",
                 "--kconfig", "../../Kconfig",

docs/en/api-reference/peripherals/temp_sensor.rst

@@ -1,5 +1,5 @@
 ESP32-S2 Temperature Sensor
-==================
+===========================
 
 Overview
 --------

tools/ci/config/build.yml

@@ -250,13 +250,11 @@ build_docs:
     - cd en
     - make gh-linkcheck
     - make html
-    # TODO: revert it before release esp32s2
+    - ../check_doc_warnings.sh
-    # - ../check_doc_warnings.sh
     - cd ../zh_CN
     - make gh-linkcheck
     - make html
-    # TODO: revert it before release esp32s2
+    - ../check_doc_warnings.sh
-    #- ../check_doc_warnings.sh
 
 verify_cmake_style:
   extends: .check_job_template