add_permalinks() — fastapi Function Reference

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

Function python FastAPI Responses calls 1

Entity Profile

FastAPI→ Responses→ add_permalinks() — fastapi Function Reference

Dependency Diagram

graph TD
  acca33db_ce7a_6048_24fb_0f8f70535828["add_permalinks()"]
  089911a1_02c3_0f6b_d62d_71c980ade67e["docs.py"]
  acca33db_ce7a_6048_24fb_0f8f70535828 -->|defined in| 089911a1_02c3_0f6b_d62d_71c980ade67e
  ee158d7d_d0df_df2d_c16a_072bb9b8958c["add_permalinks_page()"]
  acca33db_ce7a_6048_24fb_0f8f70535828 -->|calls| ee158d7d_d0df_df2d_c16a_072bb9b8958c
  style acca33db_ce7a_6048_24fb_0f8f70535828 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/docs.py lines 518–523

def add_permalinks(update_existing: bool = False) -> None:
    """
    Add or update header permalinks in all pages of En docs.
    """
    for md_file in en_docs_path.rglob("*.md"):
        add_permalinks_page(md_file, update_existing=update_existing)