doc: Fix cool URIs

xkbcommon · Feb 16, 2025 · 3768084 · 3768084
1 parent aa2928f
commit 3768084
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 17 deletions.
diff --git a/doc/cool-uris.yaml b/doc/cool-uris.yaml
@@ -2,11 +2,13 @@
 #          Do not edit manually.
 annotated.html: []
 classes.html: []
+debugging.html: []
 deprecated.html: []
 dir_63ce773eee1f9b680e6e312b48cc99ca.html: []
 dir_891596f32582d3133e8915e72908625f.html: []
 dir_d44c64559bbebec7f509842c48db8b23.html: []
 dir_e68e8157741866f444e17edd764ebbae.html: []
+doxygen_crawl.html: []
 error-index.html: []
 files.html: []
 functions.html: []
@@ -33,8 +35,9 @@ group__x11.html: []
 index.html: []
 keymap-text-format-v1.html:
 - md_doc_keymap_format_text_v1.html
-md_doc_quick_guide.html: []
-modules.html: []
+md_doc_2quick-guide.html:
+- md_doc_quick_guide.html
+meson_options.html: []
 pages.html: []
 rule-file-format.html:
 - md_doc_rules_format.html
@@ -54,6 +57,8 @@ structxkb__keymap.html: []
 structxkb__rule__names.html: []
 structxkb__state.html: []
 todo.html: []
+topics.html:
+- modules.html
 user-configuration.html:
 - md_doc_user_configuration.html
 xkb-intro.html: []

diff --git a/scripts/ensure-stable-doc-urls.py b/scripts/ensure-stable-doc-urls.py
@@ -28,12 +28,14 @@ class ExitCode(IntFlag):
     NORMAL = 0
     INVALID_UPDATES = 1 << 4
     MISSING_UPDATES = 1 << 5
+    NON_UNIQUE_DIRECTIONS = 1 << 6
 
 
 THIS_SCRIPT_PATH = Path(__file__)
 RELATIVE_SCRIPT_PATH = THIS_SCRIPT_PATH.relative_to(THIS_SCRIPT_PATH.parent.parent)
 
 REDIRECTION_DELAY = 6  # in seconds. Note: at least 6s for accessibility
+REDIRECTION_TITLE = "xkbcommon: Page Redirection"
 
 # NOTE: The redirection works with the HTML tag: <meta http-equiv="refresh">.
 # See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#http-equiv
@@ -50,7 +52,7 @@ class ExitCode(IntFlag):
         <meta http-equiv="refresh" content="${delay}; url=${canonical}">
         <link href="doxygen.css" rel="stylesheet" type="text/css">
         <link href="doxygen-extra.css" rel="stylesheet" type="text/css">
-        <title>xkbcommon: Page Redirection</title>
+        <title>${title}</title>
     </head>
     <body>
         <div id="top">
@@ -87,6 +89,14 @@ def parse_page_update(update: str) -> Update:
     return updateʹ
 
 
+def is_page_redirection(path: Path):
+    with path.open("rt", encoding="utf-8") as fd:
+        for line in fd:
+            if REDIRECTION_TITLE in line:
+                return True
+    return False
+
+
 def update_registry(registry_path: Path, doc_dir: Path, updates: Sequence[str]):
     """
     Update the URL registry by:
@@ -95,21 +105,28 @@ def update_registry(registry_path: Path, doc_dir: Path, updates: Sequence[str]):
     """
     # Parse updates
     updates_ = dict(map(parse_page_update, updates))
+    # Update
+    invalid_updates = set(updates_)
     # Load previous registry
     with registry_path.open("rt", encoding="utf-8") as fd:
-        registry = yaml.safe_load(fd) or {}
+        registry: dict[str, list[str]] = yaml.safe_load(fd) or {}
     # Expected updates
     missing_updates = set(file for file in registry if not (doc_dir / file).is_file())
-    # Update
-    invalid_updates = set(updates_)
+    # Ensure each page is unique
+    for d, rs in registry.items():
+        if clashes := frozenset(rs).intersection(registry):
+            print(
+                f"[ERROR] The following redirections of “{d}”",
+                f"clash with canonical directions: {clashes}",
+            )
+            exit(ExitCode.NON_UNIQUE_DIRECTIONS)
     redirections = frozenset(chain(*registry.values()))
     for file in glob.iglob("**/*.html", root_dir=doc_dir, recursive=True):
         # Skip redirection pages
         if file in redirections:
             continue
         # Get previous entry and potential update
-        old = updates_.get(file)
-        if old:
+        if old := updates_.get(file):
             # Update old entry
             invalid_updates.remove(file)
             entry = registry.get(old)
@@ -137,8 +154,21 @@ def update_registry(registry_path: Path, doc_dir: Path, updates: Sequence[str]):
         exit_code |= ExitCode.INVALID_UPDATES
     if missing_updates:
         for old in missing_updates:
-            print(f"[ERROR] “{old}” not found and has no update.")
-        exit_code |= ExitCode.MISSING_UPDATES
+            # Handle older Doxygen versions
+            old_redirections = registry[old]
+            for r in old_redirections:
+                path = doc_dir / r
+                if path.is_file() and not is_page_redirection(path):
+                    print(
+                        "[WARNING] Handling old Doxygen version:",
+                        f"use “{r}” instead of “{old}” for the canonical direction",
+                    )
+                    missing_updates.remove(old)
+                    break
+            else:
+                print(f"[ERROR] “{old}” not found and has no update.")
+        if missing_updates:
+            exit_code |= ExitCode.MISSING_UPDATES
     if exit_code:
         print("[ERROR] Processing interrupted: please fix the errors above.")
         exit(exit_code.value)
@@ -159,22 +189,36 @@ def generate_redirections(registry_path: Path, doc_dir: Path):
     cool = True
     # Load registry
     with registry_path.open("rt", encoding="utf-8") as fd:
-        registry = yaml.safe_load(fd) or {}
+        registry: dict[str, list[str]] = yaml.safe_load(fd) or {}
     for canonical, aliases in registry.items():
         # Check canonical path is up-to-date
         if not (doc_dir / canonical).is_file():
-            cool = False
-            print(
-                f"ERROR: missing canonical documentation page “{canonical}”. "
-                f"Please update “{registry_path}” using {RELATIVE_SCRIPT_PATH}”."
-            )
+            # Handle older Doxygen versions
+            for r in aliases:
+                path = doc_dir / r
+                if path.is_file() and not is_page_redirection(path):
+                    print(
+                        "[WARNING] Handling old Doxygen version:",
+                        f"use “{r}” instead of “{canonical}” for the canonical direction",
+                    )
+                    canonical = r
+                    aliases.remove(r)
+                    break
+            else:
+                cool = False
+                print(
+                    f"ERROR: missing canonical documentation page “{canonical}”. "
+                    f"Please update “{registry_path}” using {RELATIVE_SCRIPT_PATH}”."
+                )
         # Add a redirection page
         for alias in aliases:
             path = doc_dir / alias
             with path.open("wt", encoding="utf-8") as fd:
                 fd.write(
                     REDIRECTION_PAGE_TEMPLATE.substitute(
-                        canonical=canonical, delay=REDIRECTION_DELAY
+                        canonical=canonical,
+                        delay=REDIRECTION_DELAY,
+                        title=REDIRECTION_TITLE,
                     )
                 )
     if not cool: