on_files() — fastapi Function Reference

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

Function python FastAPI Applications calls 2

Entity Profile

FastAPI→ Applications→ on_files() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

scripts/mkdocs_hooks.py lines 96–104

def on_files(files: Files, *, config: MkDocsConfig) -> Files:
    resolve_files(items=config.nav or [], files=files, config=config)
    if "logo" in config.theme:
        resolve_file(item=config.theme["logo"], files=files, config=config)
    if "favicon" in config.theme:
        resolve_file(item=config.theme["favicon"], files=files, config=config)
    resolve_files(items=config.extra_css, files=files, config=config)
    resolve_files(items=config.extra_javascript, files=files, config=config)
    return files