From e6a8751df7a68144952d5b21b0d4a76327b6c9f7 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Fri, 5 Jun 2026 08:06:29 -0700 Subject: [PATCH] Restore api.html redirect to fix broken deep links Re-enable generation of the api.html redirect page during docs deploy so legacy links such as api.html#udt forward to the new MkDocs api/ page with their URL hash preserved. --- support/mkdocs | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/support/mkdocs b/support/mkdocs index 94eddae3..e595a2be 100755 --- a/support/mkdocs +++ b/support/mkdocs @@ -71,15 +71,18 @@ if len(args) > 0: # mike stages files added by deploy for deletion for unclear reason, # undo it. ret = call(['git', 'reset', '--hard'], cwd=site_dir) - if False: - os.makedirs(current_doc_path, exist_ok=True) - redirect_page_path = os.path.join(current_doc_path, 'api.html') - with open(redirect_page_path, "w") as file: - file.write(redirect_page) - ret = call(['git', 'add', redirect_page_path], cwd=site_dir) - if ret != 0: - sys.exit(ret) - ret = call(['git', 'commit', '--amend', '--no-edit'], cwd=site_dir) + if ret != 0: + sys.exit(ret) + # Generate a redirect page from the old Sphinx api.html to the new api/ + # page, preserving the URL hash so links such as api.html#udt keep working. + os.makedirs(current_doc_path, exist_ok=True) + redirect_page_path = os.path.join(current_doc_path, 'api.html') + with open(redirect_page_path, "w") as file: + file.write(redirect_page) + ret = call(['git', 'add', redirect_page_path], cwd=site_dir) + if ret != 0: + sys.exit(ret) + ret = call(['git', 'commit', '--amend', '--no-edit'], cwd=site_dir) sys.exit(ret) elif not command.startswith('-'): args += ['-f', config_path]