remove_header_permalinks() — fastapi Function Reference

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

Function python FastAPI Applications called by 1

Entity Profile

FastAPI→ Applications→ remove_header_permalinks() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

scripts/docs.py lines 196–204

def remove_header_permalinks(content: str):
    lines: list[str] = []
    for line in content.split("\n"):
        match = header_with_permalink_pattern.match(line)
        if match:
            hashes, title, *_ = match.groups()
            line = f"{hashes} {title}"
        lines.append(line)
    return "\n".join(lines)