fastapi Architecture Docs
Home / Function/ on_nav() — fastapi Function Reference

on_nav() — fastapi Function Reference

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

Function python FastAPI Responses calls 1

Entity Profile

Dependency Diagram

graph TD
  fef0cf63_79b1_2b79_db6c_e7f1f3cbae4f["on_nav()"]
  566dbae4_46de_4e4a_0ed4_0c59e40fbcf8["mkdocs_hooks.py"]
  fef0cf63_79b1_2b79_db6c_e7f1f3cbae4f -->|defined in| 566dbae4_46de_4e4a_0ed4_0c59e40fbcf8
  2007df4a_6adb_2384_a345_15bd16e50f60["generate_renamed_section_items()"]
  fef0cf63_79b1_2b79_db6c_e7f1f3cbae4f -->|calls| 2007df4a_6adb_2384_a345_15bd16e50f60
  style fef0cf63_79b1_2b79_db6c_e7f1f3cbae4f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/mkdocs_hooks.py lines 132–136

def on_nav(
    nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
    new_items = generate_renamed_section_items(nav.items, config=config)
    return Navigation(items=new_items, pages=nav.pages)

Domain

Subdomains

Defined In

Calls

Source

Frequently Asked Questions

What does on_nav() do?
on_nav() is a function in the fastapi codebase, defined in scripts/mkdocs_hooks.py.
Where is on_nav() defined?
on_nav() is defined in scripts/mkdocs_hooks.py at line 132.
What does on_nav() call?
on_nav() calls 1 function(s): generate_renamed_section_items.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free