espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/usb-docs-link-esp-usb' into 'master'

Browse Source 
docs(usb): Move USB docs to esp-usb and add redirects

Closes IDF-13559

See merge request espressif/esp-idf!45997
This commit is contained in:
Tomas Rezucha
2026-03-11 11:41:52 +01:00
parent 71da0fdf4a c30851292f
commit 506dbc2985
39 changed files with 47 additions and 3746 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf_common.py
+19 -14
View File
@@ -154,19 +154,6 @@ TOUCH_SENSOR_DOCS = ['api-reference/peripherals/cap_touch_sens.rst']
SPIRAM_DOCS = ['api-guides/external-ram.rst']
USB_DOCS = [
'api-reference/peripherals/usb_device.rst',
'api-reference/peripherals/usb_host.rst',
'api-reference/peripherals/usb_host/usb_host_notes_arch.rst',
'api-reference/peripherals/usb_host/usb_host_notes_design.rst',
'api-reference/peripherals/usb_host/usb_host_notes_dwc_otg.rst',
'api-reference/peripherals/usb_host/usb_host_notes_index.rst',
'api-reference/peripherals/usb_host/usb_host_notes_usbh.rst',
'api-reference/peripherals/usb_host/usb_host_notes_enum.rst',
'api-reference/peripherals/usb_host/usb_host_notes_ext_hub.rst',
'api-reference/peripherals/usb_host/usb_host_notes_ext_port.rst',
]
I80_LCD_DOCS = ['api-reference/peripherals/lcd/i80_lcd.rst']
RGB_LCD_DOCS = ['api-reference/peripherals/lcd/rgb_lcd.rst']
DSI_LCD_DOCS = ['api-reference/peripherals/lcd/dsi_lcd.rst']
@@ -361,7 +348,6 @@ conditional_include_dict = {
'SOC_SDMMC_HOST_SUPPORTED': SDMMC_DOCS,
'SOC_SDIO_SLAVE_SUPPORTED': SDIO_SLAVE_DOCS,
'SOC_MCPWM_SUPPORTED': MCPWM_DOCS,
'SOC_USB_OTG_SUPPORTED': USB_DOCS,
'SOC_USB_SERIAL_JTAG_SUPPORTED': USB_SERIAL_JTAG_DOCS,
'SOC_DEDICATED_GPIO_SUPPORTED': DEDIC_GPIO_DOCS,
'SOC_LCD_I80_SUPPORTED': I80_LCD_DOCS,
@@ -512,6 +498,21 @@ QEMU_TARGETS = ['esp32', 'esp32c3', 'esp32s3']
ESP_TEE_TARGETS = ['esp32c6', 'esp32h2', 'esp32c5', 'esp32c61']
def _resolve_redirect_page_macros(redirect_pages, target, language):
replace_map = {
'{IDF_TARGET_PATH_NAME}': target,
'{IDF_DOCS_LANGUAGE}': language,
}
resolved_redirect_pages = []
for old_url, new_url in redirect_pages:
for macro, value in replace_map.items():
new_url = new_url.replace(macro, value)
resolved_redirect_pages.append((old_url, new_url))
return resolved_redirect_pages
# Callback function for user setup that needs be done after `config-init`-event
# config.idf_target is not available at the initial config stage
def conf_setup(app, config):
@@ -534,6 +535,10 @@ def conf_setup(app, config):
# Not for all target
pass
config.html_redirect_pages = _resolve_redirect_page_macros(
config.html_redirect_pages, config.idf_target, config.language
)
config.html_baseurl = f'https://docs.espressif.com/projects/esp-idf/{config.language}/stable/{config.idf_target}'