alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-12-16 04:22:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add option to redirect documentation pages which have moved

Browse Source
This commit is contained in:
Angus Gratton
2018-12-03 17:58:08 +11:00
committed by Angus Gratton
parent 6a4955ef74
commit b240a181b7
2 changed files with 84 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/conf_common.py
View File

@@ -140,7 +140,8 @@ extensions = ['breathe',
'sphinxcontrib.actdiag',
'sphinxcontrib.nwdiag',
'sphinxcontrib.rackdiag',
'sphinxcontrib.packetdiag'
'sphinxcontrib.packetdiag',
'html_redirects',
]
# Set up font for blockdiag, nwdiag, rackdiag and packetdiag
@@ -232,6 +233,20 @@ pygments_style = 'sphinx'
# -- Options for HTML output ----------------------------------------------
# Custom added feature to allow redirecting old URLs
#
# list of tuples (old_url, new_url) for pages to redirect
# (URLs should be relative to document root, only)
html_redirect_pages = [('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'),]
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'