_construct_markdown_link() — fastapi Function Reference

Architecture documentation for the _construct_markdown_link() function in doc_parsing_utils.py from the fastapi codebase.

Function python FastAPI Applications calls 1 called by 1

Entity Profile

FastAPI→ Applications→ _construct_markdown_link() — fastapi Function Reference

Dependency Diagram

graph TD
  88c955bc_31b8_3ca8_ac86_c3d85778b519["_construct_markdown_link()"]
  c463d6a9_085f_f272_b9fc_455b7e9b6a57["doc_parsing_utils.py"]
  88c955bc_31b8_3ca8_ac86_c3d85778b519 -->|defined in| c463d6a9_085f_f272_b9fc_455b7e9b6a57
  ed2c5129_3dfc_5c6c_1e50_515c9e4e6284["replace_markdown_links()"]
  ed2c5129_3dfc_5c6c_1e50_515c9e4e6284 -->|calls| 88c955bc_31b8_3ca8_ac86_c3d85778b519
  aa93488d_92f1_0a8b_cd55_27a49e4e659d["_add_lang_code_to_url()"]
  88c955bc_31b8_3ca8_ac86_c3d85778b519 -->|calls| aa93488d_92f1_0a8b_cd55_27a49e4e659d
  style 88c955bc_31b8_3ca8_ac86_c3d85778b519 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 287–307

def _construct_markdown_link(
    url: str,
    text: str,
    title: Union[str, None],
    attributes: Union[str, None],
    lang_code: str,
) -> str:
    """
    Construct a markdown link, adjusting the URL for the given language code if needed.
    """
    url = _add_lang_code_to_url(url, lang_code)

    if title:
        link = f'[{text}]({url} "{title}")'
    else:
        link = f"[{text}]({url})"

    if attributes:
        link += f"{{{attributes}}}"

    return link