generate_readme() — fastapi Function Reference

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

Function python FastAPI Responses calls 1

Entity Profile

FastAPI→ Responses→ generate_readme() — fastapi Function Reference

Dependency Diagram

graph TD
  f3b79252_3976_bd00_9a81_a6bf039b0b0b["generate_readme()"]
  089911a1_02c3_0f6b_d62d_71c980ade67e["docs.py"]
  f3b79252_3976_bd00_9a81_a6bf039b0b0b -->|defined in| 089911a1_02c3_0f6b_d62d_71c980ade67e
  1b3248c4_45ec_d751_0492_63d333391dcb["generate_readme_content()"]
  f3b79252_3976_bd00_9a81_a6bf039b0b0b -->|calls| 1b3248c4_45ec_d751_0492_63d333391dcb
  style f3b79252_3976_bd00_9a81_a6bf039b0b0b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/docs.py lines 239–251

def generate_readme() -> None:
    """
    Generate README.md content from main index.md
    """
    readme_path = Path("README.md")
    old_content = readme_path.read_text("utf-8")
    new_content = generate_readme_content()
    if new_content != old_content:
        print("README.md outdated from the latest index.md")
        print("Updating README.md")
        readme_path.write_text(new_content, encoding="utf-8")
        raise typer.Exit(1)
    print("README.md is up to date ✅")