generate_readme_content() — fastapi Function Reference

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

Function python FastAPI Routing calls 1 called by 1

Entity Profile

FastAPI→ Routing→ generate_readme_content() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

scripts/docs.py lines 207–235

def generate_readme_content() -> str:
    en_index = en_docs_path / "docs" / "index.md"
    content = en_index.read_text("utf-8")
    content = remove_header_permalinks(content)  # remove permalinks from headers
    match_pre = re.search(r"</style>\n\n", content)
    match_start = re.search(r"<!-- sponsors -->", content)
    match_end = re.search(r"<!-- /sponsors -->", content)
    sponsors_data_path = en_docs_path / "data" / "sponsors.yml"
    sponsors = mkdocs.utils.yaml_load(sponsors_data_path.read_text(encoding="utf-8"))
    if not (match_start and match_end):
        raise RuntimeError("Couldn't auto-generate sponsors section")
    if not match_pre:
        raise RuntimeError("Couldn't find pre section (<style>) in index.md")
    frontmatter_end = match_pre.end()
    pre_end = match_start.end()
    post_start = match_end.start()
    template = Template(index_sponsors_template)
    message = template.render(sponsors=sponsors)
    pre_content = content[frontmatter_end:pre_end]
    post_content = content[post_start:]
    new_content = pre_content + message + post_content
    # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
    new_content = re.sub(
        r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
        "",
        new_content,
        flags=re.DOTALL,
    )
    return new_content