alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Load page redirects from a file instead of inline in config

Browse Source
This commit is contained in:
Angus Gratton 2019-06-23 12:07:06 +10:00 committed by Angus Gratton
parent 47bbb107a8
commit 86dbe9299a
2 changed files with 34 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/conf_common.py
View File

@ -18,6 +18,7 @@ from __future__ import print_function
from __future__ import unicode_literals from __future__ import unicode_literals
import sys import sys
import os import os
import re
import subprocess import subprocess
# Note: If extensions (or modules to document with autodoc) are in another directory, # Note: If extensions (or modules to document with autodoc) are in another directory,
@ -235,25 +236,14 @@ pygments_style = 'sphinx'
# Custom added feature to allow redirecting old URLs # Custom added feature to allow redirecting old URLs
# #
# list of tuples (old_url, new_url) for pages to redirect # Redirects should be listed in page_redirects.xt
# (URLs should be relative to document root, only) #
html_redirect_pages = [('api-reference/ethernet/index', 'api-reference/network/index'), with open("../page_redirects.txt") as f:
('api-reference/ethernet/esp_eth', 'api-reference/network/esp_eth'), lines = [re.sub(" +", " ", l.strip()) for l in f.readlines() if l.strip() != "" and not l.startswith("#")]
('api-reference/mesh/index', 'api-reference/network/index'), for line in lines: # check for well-formed entries
('api-reference/mesh/esp_mesh', 'api-reference/network/esp_mesh'), if len(line.split(' ')) != 2:
('api-reference/wifi/index', 'api-reference/network/index'), raise RuntimeError("Invalid line in page_redirects.txt: %s" % line)
('api-reference/wifi/esp_now', 'api-reference/network/esp_now'), html_redirect_pages = [tuple(l.split(' ')) for l in lines]
('api-reference/wifi/esp_smartconfig', 'api-reference/network/esp_smartconfig'),
('api-reference/wifi/esp_wifi', 'api-reference/network/esp_wifi'),
('api-reference/system/tcpip_adapter', 'api-reference/network/tcpip_adapter'),
('get-started/idf-monitor', 'api-guides/tools/idf-monitor'),
('get-started-cmake/idf-monitor', 'api-guides/tools/idf-monitor'),
('get-started/get-started-devkitc', 'hw-reference/get-started-devkitc'),
('get-started/get-started-wrover-kit', 'hw-reference/get-started-wrover-kit'),
('get-started/get-started-pico-kit', 'hw-reference/get-started-pico-kit'),
('get-started-cmake/get-started-devkitc', 'hw-reference/get-started-devkitc'),
('get-started-cmake/get-started-wrover-kit', 'hw-reference/get-started-wrover-kit'),
('get-started-cmake/get-started-pico-kit', 'hw-reference/get-started-pico-kit')]
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.

25
docs/page_redirects.txt Normal file
View File

@ -0,0 +1,25 @@
# Redirects from "old URL" "new URL"
#
# Space delimited
#
# New URL should be relative to document root, only)
#
# Empty lines and lines starting with # are ignored
api-reference/ethernet/index api-reference/network/index
api-reference/ethernet/esp_eth api-reference/network/esp_eth
api-reference/mesh/index api-reference/network/index
api-reference/mesh/esp_mesh api-reference/network/esp_mesh
api-reference/wifi/index api-reference/network/index
api-reference/wifi/esp_now api-reference/network/esp_now
api-reference/wifi/esp_smartconfig api-reference/network/esp_smartconfig
api-reference/wifi/esp_wifi api-reference/network/esp_wifi
api-reference/system/tcpip_adapter api-reference/network/tcpip_adapter
get-started/idf-monitor api-guides/tools/idf-monitor
get-started-cmake/idf-monitor api-guides/tools/idf-monitor
get-started/get-started-devkitc hw-reference/get-started-devkitc
get-started/get-started-wrover-kit hw-reference/get-started-wrover-kit
get-started/get-started-pico-kit hw-reference/get-started-pico-kit
get-started-cmake/get-started-devkitc hw-reference/get-started-devkitc
get-started-cmake/get-started-wrover-kit hw-reference/get-started-wrover-kit
get-started-cmake/get-started-pico-kit hw-reference/get-started-pico-kit