build_all() — fastapi Function Reference

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

Function python FastAPI Applications calls 2 called by 1

Entity Profile

FastAPI→ Applications→ build_all() — fastapi Function Reference

Dependency Diagram

graph TD
  7a817bd6_0a4c_302b_47a6_6d0a82232601["build_all()"]
  089911a1_02c3_0f6b_d62d_71c980ade67e["docs.py"]
  7a817bd6_0a4c_302b_47a6_6d0a82232601 -->|defined in| 089911a1_02c3_0f6b_d62d_71c980ade67e
  8c9524ad_0b65_9164_d276_a1c8791cb295["build_lang()"]
  8c9524ad_0b65_9164_d276_a1c8791cb295 -->|calls| 7a817bd6_0a4c_302b_47a6_6d0a82232601
  94647f4e_574e_b56c_5e99_8caf1b29664e["update_languages()"]
  7a817bd6_0a4c_302b_47a6_6d0a82232601 -->|calls| 94647f4e_574e_b56c_5e99_8caf1b29664e
  7057f227_6b9c_6d7e_0958_8e852a5a06e4["get_lang_paths()"]
  7a817bd6_0a4c_302b_47a6_6d0a82232601 -->|calls| 7057f227_6b9c_6d7e_0958_8e852a5a06e4
  style 7a817bd6_0a4c_302b_47a6_6d0a82232601 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/docs.py lines 255–271

def build_all() -> None:
    """
    Build mkdocs site for en, and then build each language inside, end result is located
    at directory ./site/ with each language inside.
    """
    update_languages()
    shutil.rmtree(site_path, ignore_errors=True)
    langs = [
        lang.name
        for lang in get_lang_paths()
        if (lang.is_dir() and lang.name in SUPPORTED_LANGS)
    ]
    cpu_count = os.cpu_count() or 1
    process_pool_size = cpu_count * 4
    typer.echo(f"Using process pool size: {process_pool_size}")
    with Pool(process_pool_size) as p:
        p.map(build_lang, langs)