live() — fastapi Function Reference

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

Function python FastAPI Applications called by 1

Entity Profile

FastAPI→ Applications→ live() — fastapi Function Reference

Dependency Diagram

graph TD
  1ee508b4_5541_8908_952c_808cdb906c5e["live()"]
  089911a1_02c3_0f6b_d62d_71c980ade67e["docs.py"]
  1ee508b4_5541_8908_952c_808cdb906c5e -->|defined in| 089911a1_02c3_0f6b_d62d_71c980ade67e
  83e300d5_cb80_9ae9_5ff4_d2db0f895aae["serve()"]
  83e300d5_cb80_9ae9_5ff4_d2db0f895aae -->|calls| 1ee508b4_5541_8908_952c_808cdb906c5e
  style 1ee508b4_5541_8908_952c_808cdb906c5e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/docs.py lines 315–340

def live(
    lang: str = typer.Argument(
        None, callback=lang_callback, autocompletion=complete_existing_lang
    ),
    dirty: bool = False,
) -> None:
    """
    Serve with livereload a docs site for a specific language.

    This only shows the actual translated files, not the placeholders created with
    build-all.

    Takes an optional LANG argument with the name of the language to serve, by default
    en.
    """
    # Enable line numbers during local development to make it easier to highlight
    if lang is None:
        lang = "en"
    lang_path: Path = docs_path / lang
    # Enable line numbers during local development to make it easier to highlight
    args = ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008"]
    if dirty:
        args.append("--dirty")
    subprocess.run(
        args, env={**os.environ, "LINENUMS": "true"}, cwd=lang_path, check=True
    )