|
| 1 | +# Licensed to the Apache Software Foundation (ASF) under one |
| 2 | +# or more contributor license agreements. See the NOTICE file |
| 3 | +# distributed with this work for additional information |
| 4 | +# regarding copyright ownership. The ASF licenses this file |
| 5 | +# to you under the Apache License, Version 2.0 (the |
| 6 | +# "License"); you may not use this file except in compliance |
| 7 | +# with the License. You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, |
| 12 | +# software distributed under the License is distributed on an |
| 13 | +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +# KIND, either express or implied. See the License for the |
| 15 | +# specific language governing permissions and limitations |
| 16 | +# under the License. |
| 17 | + |
| 18 | +"""Convert sphinx-multiversion metadata into the version switcher JSON. |
| 19 | +
|
| 20 | +Usage: |
| 21 | + python docs/tools/write_versions_json.py <html_root> [--base-url /] |
| 22 | +""" |
| 23 | + |
| 24 | +from __future__ import annotations |
| 25 | + |
| 26 | +import argparse |
| 27 | +import json |
| 28 | +from datetime import datetime |
| 29 | +from pathlib import Path |
| 30 | + |
| 31 | +from packaging import version as pkg_version |
| 32 | + |
| 33 | +ROOT_VERSION = "main" |
| 34 | +DEFAULT_BASE_URL = "/" |
| 35 | +METADATA_NAME = "versions_metadata.json" |
| 36 | + |
| 37 | + |
| 38 | +def _parse_creatordate(raw: str) -> datetime: |
| 39 | + try: |
| 40 | + return datetime.strptime(raw, "%Y-%m-%d %H:%M:%S %z") |
| 41 | + except Exception: |
| 42 | + return datetime.min.replace(tzinfo=None) |
| 43 | + |
| 44 | + |
| 45 | +def _load_versions(metadata_path: Path) -> list[dict[str, object]]: |
| 46 | + metadata = json.loads(metadata_path.read_text(encoding="utf-8")) |
| 47 | + versions = [] |
| 48 | + for name, entry in metadata.items(): |
| 49 | + version_label = entry.get("version") or name |
| 50 | + if version_label in {"0.0.0", "0+unknown"}: |
| 51 | + version_label = name |
| 52 | + versions.append( |
| 53 | + { |
| 54 | + "name": name, |
| 55 | + "version": version_label, |
| 56 | + "is_released": bool(entry.get("is_released")), |
| 57 | + "creatordate": _parse_creatordate(entry.get("creatordate", "")), |
| 58 | + } |
| 59 | + ) |
| 60 | + return versions |
| 61 | + |
| 62 | + |
| 63 | +def _pick_preferred(versions: list[dict[str, object]], latest: str) -> str: |
| 64 | + non_main = [v for v in versions if v["name"] != "main"] |
| 65 | + released = [v for v in non_main if v["is_released"]] |
| 66 | + if released: |
| 67 | + return max(released, key=lambda v: v["creatordate"])["name"] |
| 68 | + if non_main: |
| 69 | + return max(non_main, key=lambda v: v["creatordate"])["name"] |
| 70 | + return latest |
| 71 | + |
| 72 | + |
| 73 | +def _to_switcher( |
| 74 | + versions: list[dict[str, object]], preferred_name: str, base_url: str |
| 75 | +) -> list[dict[str, object]]: |
| 76 | + base = base_url.rstrip("/") |
| 77 | + main_entry: dict[str, object] | None = None |
| 78 | + tag_entries: list[dict[str, object]] = [] |
| 79 | + |
| 80 | + for v in versions: |
| 81 | + entry: dict[str, object] = { |
| 82 | + "name": v["name"], |
| 83 | + "version": v["version"], |
| 84 | + "url": f"{base}/{v['name']}/" if base else f"/{v['name']}/", |
| 85 | + } |
| 86 | + if v["name"] == "main": |
| 87 | + main_entry = entry |
| 88 | + else: |
| 89 | + tag_entries.append(entry) |
| 90 | + |
| 91 | + def _sort_key(entry: dict[str, object]) -> pkg_version.Version: |
| 92 | + name = str(entry["name"]) |
| 93 | + label = name[1:] if name.startswith("v") else name |
| 94 | + try: |
| 95 | + return pkg_version.parse(label) |
| 96 | + except Exception: |
| 97 | + return pkg_version.parse("0") |
| 98 | + |
| 99 | + tag_entries.sort(key=_sort_key, reverse=True) |
| 100 | + |
| 101 | + ordered = tag_entries |
| 102 | + if main_entry: |
| 103 | + ordered.append(main_entry) |
| 104 | + |
| 105 | + for entry in ordered: |
| 106 | + if entry["name"] == preferred_name: |
| 107 | + entry["preferred"] = True |
| 108 | + return ordered |
| 109 | + |
| 110 | + |
| 111 | +def _write_root_index(html_root: Path, target_version: str, base_url: str) -> None: |
| 112 | + base = base_url.rstrip("/") or "/" |
| 113 | + target = f"{base}/{target_version}/" if base != "/" else f"/{target_version}/" |
| 114 | + html_root.mkdir(parents=True, exist_ok=True) |
| 115 | + index_path = html_root / "index.html" |
| 116 | + index_path.write_text( |
| 117 | + "\n".join( |
| 118 | + [ |
| 119 | + "<!DOCTYPE html>", |
| 120 | + '<meta charset="utf-8" />', |
| 121 | + "<title>tvm-ffi docs</title>", |
| 122 | + f'<meta http-equiv="refresh" content="0; url={target}" />', |
| 123 | + "<script>", |
| 124 | + f"location.replace('{target}');", |
| 125 | + "</script>", |
| 126 | + f'<p>Redirecting to <a href="{target}">{target}</a>.</p>', |
| 127 | + ] |
| 128 | + ), |
| 129 | + encoding="utf-8", |
| 130 | + ) |
| 131 | + print(f"Wrote root index redirect to {target}") |
| 132 | + |
| 133 | + |
| 134 | +def main() -> int: |
| 135 | + """Entrypoint.""" |
| 136 | + parser = argparse.ArgumentParser() |
| 137 | + parser.add_argument( |
| 138 | + "html_root", |
| 139 | + type=Path, |
| 140 | + help="Root of the built HTML output (expects _static/versions_metadata.json inside)", |
| 141 | + ) |
| 142 | + parser.add_argument( |
| 143 | + "--base-url", |
| 144 | + default=DEFAULT_BASE_URL, |
| 145 | + help="Base URL prefix (leading slash, no trailing slash) for version links, e.g. '/' or '/ffi'", |
| 146 | + ) |
| 147 | + args = parser.parse_args() |
| 148 | + |
| 149 | + html_root = args.html_root |
| 150 | + metadata_path = html_root / "_static" / METADATA_NAME |
| 151 | + metadata_path.parent.mkdir(parents=True, exist_ok=True) |
| 152 | + |
| 153 | + versions = _load_versions(metadata_path) |
| 154 | + preferred_name = _pick_preferred(versions, ROOT_VERSION) |
| 155 | + output = _to_switcher(versions, preferred_name, args.base_url) |
| 156 | + |
| 157 | + out_path = html_root / "_static" / "versions.json" |
| 158 | + out_path.parent.mkdir(parents=True, exist_ok=True) |
| 159 | + out_path.write_text(json.dumps(output, indent=2), encoding="utf-8") |
| 160 | + print(f"Wrote version switcher data for {len(output)} entries to {out_path}") |
| 161 | + |
| 162 | + _write_root_index(html_root, preferred_name, args.base_url) |
| 163 | + return 0 |
| 164 | + |
| 165 | + |
| 166 | +if __name__ == "__main__": |
| 167 | + raise SystemExit(main()) |
0 commit comments