Skip to content

Commit

Permalink
Merge branch 'docs/enable_h2_build' into 'master'
Browse files Browse the repository at this point in the history
docs: add support for building H2 docs

Closes IDF-6259

See merge request espressif/esp-idf!21933
  • Loading branch information
ESP-Marius committed Jan 17, 2023
2 parents 3df87a9 + 7100b7d commit 70d1dbc
Show file tree
Hide file tree
Showing 27 changed files with 699 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .gitlab/ci/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ check_docs_lang_sync:
parallel:
matrix:
- DOCLANG: ["en", "zh_CN"]
DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2", "esp32c6"]
DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2", "esp32c6", "esp32h2"]

check_docs_gh_links:
image: $ESP_IDF_DOC_ENV_IMAGE
Expand Down
4 changes: 4 additions & 0 deletions components/esp_hw_support/port/esp32h2/Kconfig.mac
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# ESP32H2-TODO: MAC support

choice ESP32H2_UNIVERSAL_MAC_ADDRESSES
bool "Number of universally administered (by IEEE) MAC address"
endchoice
6 changes: 4 additions & 2 deletions docs/conf_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@
'api-reference/bluetooth/esp_gattc.rst',
'api-reference/bluetooth/esp_blufi.rst',
'api-reference/bluetooth/index.rst',
'api-reference/bluetooth/nimble/index.rst',
'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst']
'api-reference/bluetooth/nimble/index.rst']

BLE_DOCS = ['migration-guides/release-5.x/5.0/bluetooth-low-energy.rst']

BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst',
'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst',
Expand Down Expand Up @@ -156,6 +157,7 @@

# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers
conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
'SOC_BLE_SUPPORTED':BLE_DOCS,
'SOC_BLE_MESH_SUPPORTED':BLE_MESH_DOCS,
'SOC_WIFI_SUPPORTED':WIFI_DOCS,
'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
Expand Down
275 changes: 275 additions & 0 deletions docs/docs_not_updated/esp32h2.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,275 @@
languages
contribute/esp-idf-tests-with-pytest
contribute/contributor-agreement
contribute/documenting-code
contribute/creating-examples
contribute/style-guide
contribute/copyright-guide
contribute/install-pre-commit-hook
contribute/index
api-guides/core_dump_internals
api-guides/event-handling
api-guides/performance/speed
api-guides/performance/size
api-guides/performance/ram-usage
api-guides/performance/index
api-guides/jtag-debugging/debugging-examples
api-guides/jtag-debugging/configure-ft2232h-jtag
api-guides/jtag-debugging/tips-and-quirks
api-guides/jtag-debugging/using-debugger
api-guides/jtag-debugging/building-openocd-macos
api-guides/jtag-debugging/building-openocd-linux
api-guides/jtag-debugging/esp32h2.inc
api-guides/jtag-debugging/configure-other-jtag
api-guides/jtag-debugging/building-openocd-windows
api-guides/jtag-debugging/index
api-guides/jtag-debugging/esp32.inc
api-guides/jtag-debugging/configure-builtin-jtag
api-guides/partition-tables
api-guides/app_trace
api-guides/thread-local-storage
api-guides/error-handling
api-guides/tools/idf-tools
api-guides/tools/idf-clang-tidy
api-guides/tools/idf-component-manager
api-guides/tools/idf-py
api-guides/tools/idf-windows-installer
api-guides/tools/idf-monitor
api-guides/tools/idf-tools-notes.inc
api-guides/tools/idf-docker-image
api-guides/tools/index
api-guides/startup
api-guides/hlinterrupts
api-guides/RF_calibration
api-guides/unit-tests
api-guides/deep-sleep-stub
api-guides/blufi
api-guides/lwip
api-guides/coexist
api-guides/flash_psram_config
api-guides/usb-serial-jtag-console
api-guides/linker-script-generation
api-guides/wifi
api-guides/usb-otg-console
api-guides/wireshark-user-guide
api-guides/bootloader
api-guides/esp-wifi-mesh
api-guides/cplusplus
api-guides/SYSVIEW_FreeRTOS.txt
api-guides/build-system
api-guides/freertos-smp
api-guides/core_dump
api-guides/inc/linux-host-requirements
api-guides/dfu
api-guides/esp-ble-mesh/ble-mesh-index
api-guides/esp-ble-mesh/ble-mesh-feature-list
api-guides/esp-ble-mesh/ble-mesh-terminology
api-guides/esp-ble-mesh/ble-mesh-architecture
api-guides/esp-ble-mesh/ble-mesh-faq
api-guides/external-ram
api-guides/reproducible-builds
api-guides/hardware-abstraction
api-guides/wifi-security
api-guides/host-apps
api-guides/index
api-guides/openthread
api-guides/fatal-errors
api-guides/memory-types
api-guides/general-notes
third-party-tools/platformio
COPYRIGHT
libraries-and-frameworks/libs-frameworks
libraries-and-frameworks/index
libraries-and-frameworks/cloud-frameworks
versions
api-reference/api-conventions
api-reference/template
api-reference/provisioning/protocomm
api-reference/provisioning/provisioning
api-reference/provisioning/index
api-reference/provisioning/wifi_provisioning
api-reference/storage/vfs
api-reference/storage/spiffs
api-reference/storage/wear-levelling
api-reference/storage/fatfs
api-reference/storage/nvs_partition_gen
api-reference/storage/nvs_flash
api-reference/storage/partition
api-reference/storage/sdmmc
api-reference/storage/mass_mfg
api-reference/storage/index
api-reference/storage/nvs_partition_parse
api-reference/peripherals/sdspi_share
api-reference/peripherals/gpio/esp32h2.inc
api-reference/peripherals/adc_continuous
api-reference/peripherals/adc_oneshot
api-reference/peripherals/usb_host
api-reference/peripherals/twai
api-reference/peripherals/hmac
api-reference/peripherals/usb_device
api-reference/peripherals/gpio
api-reference/peripherals/sdspi_host
api-reference/peripherals/dac
api-reference/peripherals/spi_slave
api-reference/peripherals/etm
api-reference/peripherals/i2s
api-reference/peripherals/gptimer
api-reference/peripherals/pcnt
api-reference/peripherals/touch_element
api-reference/peripherals/lcd
api-reference/peripherals/mcpwm
api-reference/peripherals/secure_element
api-reference/peripherals/ledc
api-reference/peripherals/temp_sensor
api-reference/peripherals/spi_features
api-reference/peripherals/sdio_slave
api-reference/peripherals/clk_tree
api-reference/peripherals/spi_flash/xip_from_psram.inc
api-reference/peripherals/spi_flash/spi_flash_concurrency
api-reference/peripherals/spi_flash/spi_flash_override_driver
api-reference/peripherals/spi_flash/spi_flash_optional_feature
api-reference/peripherals/spi_flash/index
api-reference/peripherals/spi_flash/auto_suspend.inc
api-reference/peripherals/sdm
api-reference/peripherals/touch_pad
api-reference/peripherals/adc_calibration
api-reference/peripherals/spi_slave_hd
api-reference/peripherals/ds
api-reference/peripherals/i2c
api-reference/peripherals/dedic_gpio
api-reference/peripherals/sd_pullup_requirements
api-reference/peripherals/spi_master
api-reference/peripherals/index
api-reference/peripherals/sdmmc_host
api-reference/peripherals/uart
api-reference/peripherals/rmt
api-reference/kconfig
api-reference/network/esp_openthread
api-reference/network/esp_eth
api-reference/network/esp_netif_driver
api-reference/network/esp_dpp
api-reference/network/esp_now
api-reference/network/esp-wifi-mesh
api-reference/network/esp_smartconfig
api-reference/network/esp_wifi
api-reference/network/index
api-reference/network/esp_netif
api-reference/system/sleep_modes
api-reference/system/ota
api-reference/system/app_trace
api-reference/system/ulp_macros
api-reference/system/perfmon
api-reference/system/ulp
api-reference/system/esp_function_with_shared_stack
api-reference/system/efuse
api-reference/system/chip_revision
api-reference/system/ulp_instruction_set
api-reference/system/async_memcpy
api-reference/system/random
api-reference/system/esp_timer
api-reference/system/esp_event
api-reference/system/freertos
api-reference/system/system_time
api-reference/system/log
api-reference/system/soc_caps
api-reference/system/internal-unstable
api-reference/system/app_image_format
api-reference/system/freertos_additions
api-reference/system/himem
api-reference/system/power_management
api-reference/system/mem_alloc
api-reference/system/wdts
api-reference/system/misc_system_api
api-reference/system/inc/power_management_esp32
api-reference/system/inc/espefuse_summary_ESP32-H2
api-reference/system/inc/revisions_ESP32-H2
api-reference/system/inc/show-efuse-table_ESP32-H2
api-reference/system/inc/power_management_esp32s2_and_later
api-reference/system/heap_debug
api-reference/system/ipc
api-reference/system/esp_https_ota
api-reference/system/ulp-risc-v
api-reference/system/esp_err
api-reference/system/console
api-reference/system/intr_alloc
api-reference/system/index
api-reference/system/pthread
api-reference/bluetooth/esp_spp
api-reference/bluetooth/esp_l2cap_bt
api-reference/bluetooth/esp_hidd
api-reference/bluetooth/esp_avrc
api-reference/bluetooth/controller_vhci
api-reference/bluetooth/esp_bt_defs
api-reference/bluetooth/esp_hf_ag
api-reference/bluetooth/esp_bt_main
api-reference/bluetooth/esp_bt_device
api-reference/bluetooth/esp_gatts
api-reference/bluetooth/esp_gattc
api-reference/bluetooth/esp_sdp
api-reference/bluetooth/bt_common
api-reference/bluetooth/nimble
api-reference/bluetooth/nimble/index
api-reference/bluetooth/esp_hf_client
api-reference/bluetooth/esp_a2dp
api-reference/bluetooth/esp_blufi
api-reference/bluetooth/bt_le
api-reference/bluetooth/esp_hf_defs
api-reference/bluetooth/esp_gap_bt
api-reference/bluetooth/esp_gatt_defs
api-reference/bluetooth/esp-ble-mesh
api-reference/bluetooth/index
api-reference/bluetooth/esp_gap_ble
api-reference/bluetooth/classic_bt
api-reference/error-codes
api-reference/index
api-reference/protocols/icmp_echo
api-reference/protocols/esp_serial_slave_link
api-reference/protocols/mqtt
api-reference/protocols/mbedtls
api-reference/protocols/esp_http_server
api-reference/protocols/esp_sdio_slave_protocol
api-reference/protocols/esp_local_ctrl
api-reference/protocols/esp_crt_bundle
api-reference/protocols/esp_http_client
api-reference/protocols/esp_https_server
api-reference/protocols/esp_spi_slave_protocol
api-reference/protocols/modbus
api-reference/protocols/esp_tls
api-reference/protocols/mdns
api-reference/protocols/index
api-reference/protocols/asio
security/flash-encryption
security/esp32h2_log.inc
security/security
security/secure-boot-v2
security/secure-boot-v1
about
resources
migration-guides/release-5.x/5.1/index
migration-guides/release-5.x/5.1/peripherals
migration-guides/release-5.x/5.0/bluetooth-classic
migration-guides/release-5.x/5.0/gcc
migration-guides/release-5.x/5.0/bluetooth-low-energy
migration-guides/release-5.x/5.0/removed-components
migration-guides/release-5.x/5.0/protocols
migration-guides/release-5.x/5.0/networking
migration-guides/release-5.x/5.0/provisioning
migration-guides/release-5.x/5.0/build-system
migration-guides/release-5.x/5.0/storage
migration-guides/release-5.x/5.0/index
migration-guides/release-5.x/5.0/system
migration-guides/release-5.x/5.0/tools
migration-guides/release-5.x/5.0/peripherals
migration-guides/index
get-started/establish-serial-connection
get-started/linux-macos-setup
get-started/linux-macos-start-project
get-started/windows-setup
get-started/start-project
get-started/flashing-troubleshooting
get-started/windows-start-project
get-started/index
get-started/windows-setup-update
404
index
hw-reference/index
1 change: 1 addition & 0 deletions docs/doxygen/Doxyfile_esp32h2
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
INPUT += \
2 changes: 1 addition & 1 deletion docs/en/api-guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ API Guides
partition-tables
performance/index
reproducible-builds
RF_calibration
:not esp32h2: RF_calibration
../security/security
:esp32: ../security/secure-boot-v1
../security/secure-boot-v2
Expand Down
Loading

0 comments on commit 70d1dbc

Please sign in to comment.