Function _write_index

scripts/docs/generate_rust_library_reference.py:621–634

(output_dir: Path)

def _write_index(output_dir: Path) -> None:
    lines = [
        frontmatter(
            "Rust Library Reference",
            "Generated Rust API reference for NeMo Relay crates.",
            3,
            normalize=_ascii,
        ),
        f"{GENERATED_BY}\n\n",
        "## Crates\n\n",
    ]
    for crate_name, _crate_dir_name, description in CRATES:
        lines.append(f"- [{crate_name}]({BASE_URL}/{_crate_slug(crate_name)}): {_escape_text(description)}\n")
    (output_dir / "index.mdx").write_text("".join(lines), encoding="utf-8")


def generate(repo_root: Path, doc_root: Path, output_dir: Path, *, run_cargo_doc: bool) -> int: