resolve_file() — fastapi Function Reference

Architecture documentation for the resolve_file() function in mkdocs_hooks.py from the fastapi codebase.

Function python FastAPI Routing called by 2

Entity Profile

FastAPI→ Routing→ resolve_file() — fastapi Function Reference

Dependency Diagram

graph TD
  8c35274a_3f5d_d896_06e3_ad7716404d01["resolve_file()"]
  566dbae4_46de_4e4a_0ed4_0c59e40fbcf8["mkdocs_hooks.py"]
  8c35274a_3f5d_d896_06e3_ad7716404d01 -->|defined in| 566dbae4_46de_4e4a_0ed4_0c59e40fbcf8
  68237fa4_a1d1_db0c_d20c_a5fd2f079ec1["resolve_files()"]
  68237fa4_a1d1_db0c_d20c_a5fd2f079ec1 -->|calls| 8c35274a_3f5d_d896_06e3_ad7716404d01
  634d48cc_44cf_cb00_7743_7305babee827["on_files()"]
  634d48cc_44cf_cb00_7743_7305babee827 -->|calls| 8c35274a_3f5d_d896_06e3_ad7716404d01
  style 8c35274a_3f5d_d896_06e3_ad7716404d01 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/mkdocs_hooks.py lines 63–76

def resolve_file(*, item: str, files: Files, config: MkDocsConfig) -> None:
    item_path = Path(config.docs_dir) / item
    if not item_path.is_file():
        en_src_dir = (Path(config.docs_dir) / "../../en/docs").resolve()
        potential_path = en_src_dir / item
        if potential_path.is_file():
            files.append(
                EnFile(
                    path=item,
                    src_dir=str(en_src_dir),
                    dest_dir=config.site_dir,
                    use_directory_urls=config.use_directory_urls,
                )
            )