🐛 Fix calling mkdocs for languages as a subprocess to fix/enable Mk…

…Docs Material search plugin (#5501) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
tiangolo · Oct 16, 2022 · e866a2c · e866a2c
1 parent 90fc429
commit e866a2c
Show file tree

Hide file tree

Showing 22 changed files with 489 additions and 2 deletions.
diff --git a/docs/az/docs/index.md b/docs/az/docs/index.md
diff --git a/docs/az/mkdocs.yml b/docs/az/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/de/mkdocs.yml b/docs/de/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/fa/mkdocs.yml b/docs/fa/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/he/mkdocs.yml b/docs/he/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/id/mkdocs.yml b/docs/id/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/nl/mkdocs.yml b/docs/nl/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/pl/mkdocs.yml b/docs/pl/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/pt/mkdocs.yml b/docs/pt/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/sq/mkdocs.yml b/docs/sq/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/sv/mkdocs.yml b/docs/sv/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/tr/mkdocs.yml b/docs/tr/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/uk/mkdocs.yml b/docs/uk/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
@@ -32,6 +32,7 @@ repo_name: tiangolo/fastapi
 repo_url: https://github.com/tiangolo/fastapi
 edit_uri: ''
 plugins:
+- search
 - markdownextradata:
     data: data
 nav:

diff --git a/scripts/docs.py b/scripts/docs.py
@@ -1,6 +1,7 @@
 import os
 import re
 import shutil
+import subprocess
 from http.server import HTTPServer, SimpleHTTPRequestHandler
 from multiprocessing import Pool
 from pathlib import Path
@@ -200,7 +201,7 @@ def build_lang(
     )
     current_dir = os.getcwd()
     os.chdir(build_lang_path)
-    mkdocs.commands.build.build(mkdocs.config.load_config(site_dir=str(dist_path)))
+    subprocess.run(["mkdocs", "build", "--site-dir", dist_path], check=True)
     os.chdir(current_dir)
     typer.secho(f"Successfully built docs for: {lang}", color=typer.colors.GREEN)
 
@@ -275,7 +276,7 @@ def build_all():
     current_dir = os.getcwd()
     os.chdir(en_docs_path)
     typer.echo("Building docs for: en")
-    mkdocs.commands.build.build(mkdocs.config.load_config(site_dir=str(site_path)))
+    subprocess.run(["mkdocs", "build", "--site-dir", site_path], check=True)
     os.chdir(current_dir)
     langs = []
     for lang in get_lang_paths():