Function sync_docs

tasks/scripts/sync_docs_website.py:261–321

(args: argparse.Namespace)

def sync_docs(args: argparse.Namespace) -> None:
    if args.source_root is None:
        raise ValueError("--source-root is required when --operation=sync")
    source_root = args.source_root.resolve()
    docs_root = args.docs_website_root.resolve()
    source_docs = source_root / "docs"
    source_fern = source_root / "fern"
    target_fern = docs_root / "fern"

    ensure_existing(source_docs, "source docs")
    ensure_existing(source_fern, "source fern config")
    ensure_existing(target_fern, "docs website fern directory")

    channel = clean_input(args.channel)
    source_ref = clean_input(args.source_ref)
    if not source_ref:
        raise ValueError("--source-ref is required when --operation=sync")
    version_slug = clean_input(args.version_slug)
    display_override = clean_input(args.display_name)
    slug = resolve_slug(channel, version_slug)
    display_name = resolve_display_name(channel, slug, source_ref, display_override)
    pages_dir = f"pages-{slug}"
    refresh_shared = channel in {"dev", "latest"}

    reset_directory(
        source_docs,
        target_fern / pages_dir,
        preserve_components=not refresh_shared,
    )
    merge_directory(
        source_fern / "assets", target_fern / "assets", overwrite=refresh_shared
    )
    merge_directory(
        source_fern / "components", target_fern / "components", overwrite=refresh_shared
    )
    if refresh_shared:
        copy_if_exists(source_fern / "main.css", target_fern / "main.css")
        copy_if_exists(
            source_fern / "fern.config.json", target_fern / "fern.config.json"
        )

    versions_dir = target_fern / "versions"
    versions_dir.mkdir(parents=True, exist_ok=True)
    write_yaml(
        versions_dir / f"{slug}.yml",
        version_navigation(source_docs / "index.yml", pages_dir),
    )

    update_docs_yml(
        target_fern / "docs.yml",
        VersionEntry(
            slug=slug,
            display_name=display_name,
            path=f"./versions/{slug}.yml",
        ),
        target_fern,
    )