update_languages() — fastapi Function Reference

Architecture documentation for the update_languages() function in docs.py from the fastapi codebase.

Function python FastAPI Routing calls 2 called by 2

Entity Profile

FastAPI→ Routing→ update_languages() — fastapi Function Reference

Dependency Diagram

graph TD
  94647f4e_574e_b56c_5e99_8caf1b29664e["update_languages()"]
  089911a1_02c3_0f6b_d62d_71c980ade67e["docs.py"]
  94647f4e_574e_b56c_5e99_8caf1b29664e -->|defined in| 089911a1_02c3_0f6b_d62d_71c980ade67e
  78487f53_c014_0416_8677_9359793a7c4c["new_lang()"]
  78487f53_c014_0416_8677_9359793a7c4c -->|calls| 94647f4e_574e_b56c_5e99_8caf1b29664e
  7a817bd6_0a4c_302b_47a6_6d0a82232601["build_all()"]
  7a817bd6_0a4c_302b_47a6_6d0a82232601 -->|calls| 94647f4e_574e_b56c_5e99_8caf1b29664e
  359364d4_2778_7625_3077_baf81c31da27["get_en_config()"]
  94647f4e_574e_b56c_5e99_8caf1b29664e -->|calls| 359364d4_2778_7625_3077_baf81c31da27
  510221b2_6268_2b2a_8fa6_14408275962d["get_updated_config_content()"]
  94647f4e_574e_b56c_5e99_8caf1b29664e -->|calls| 510221b2_6268_2b2a_8fa6_14408275962d
  style 94647f4e_574e_b56c_5e99_8caf1b29664e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/docs.py lines 275–289

def update_languages() -> None:
    """
    Update the mkdocs.yml file Languages section including all the available languages.
    """
    old_config = get_en_config()
    updated_config = get_updated_config_content()
    if old_config != updated_config:
        print("docs/en/mkdocs.yml outdated")
        print("Updating docs/en/mkdocs.yml")
        en_config_path.write_text(
            yaml.dump(updated_config, sort_keys=False, width=200, allow_unicode=True),
            encoding="utf-8",
        )
        raise typer.Exit(1)
    print("docs/en/mkdocs.yml is up to date ✅")