From: Sebastián Ramírez <tiangolo@gmail.com>
Date: Fri, 9 Aug 2024 21:30:19 +0000 (-0500)
Subject: 🔨 Update docs.py script to enable dirty reload conditionally (#11986)
X-Git-Tag: 0.112.1~40
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=06fc1c2cc82bc585d0e695d57b1d7c7a0c2e0a67;p=thirdparty%2Ffastapi%2Ffastapi.git

🔨 Update docs.py script to enable dirty reload conditionally (#11986)
---

diff --git a/scripts/docs.py b/scripts/docs.py
index fd2dd78f14..5ef5488899 100644
--- a/scripts/docs.py
+++ b/scripts/docs.py
@@ -251,6 +251,7 @@ 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.
@@ -265,11 +266,12 @@ def live(
     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(
-        ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
-        env={**os.environ, "LINENUMS": "true"},
-        cwd=lang_path,
-        check=True,
+        args, env={**os.environ, "LINENUMS": "true"}, cwd=lang_path, check=True
     )