Merge branch 'master' into add-lifespan-context-v3

tiangolo · Oct 16, 2022 · 807f811 · 807f811
2 parents 1267446 + e13df8e
commit 807f811
Show file tree

Hide file tree

Showing 24 changed files with 495 additions and 4 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/docs/release-notes.md b/docs/en/docs/release-notes.md
@@ -2,6 +2,8 @@
 
 ## Latest Changes
 
+* ⬆️ Upgrade Typer to include Rich in scripts for docs. PR [#5502](https://github.com/tiangolo/fastapi/pull/5502) by [@tiangolo](https://github.com/tiangolo).
+* 🐛 Fix calling `mkdocs` for languages as a subprocess to fix/enable MkDocs Material search plugin. PR [#5501](https://github.com/tiangolo/fastapi/pull/5501) by [@tiangolo](https://github.com/tiangolo).
 
 ## 0.85.1
 

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/pyproject.toml b/pyproject.toml
@@ -58,7 +58,9 @@ test = [
     "requests >=2.24.0,<3.0.0",
     "httpx >=0.23.0,<0.24.0",
     "email_validator >=1.1.1,<2.0.0",
-    "sqlalchemy >=1.3.18,<1.5.0",
+    # TODO: once removing databases from tutorial, upgrade SQLAlchemy
+    # probably when including SQLModel
+    "sqlalchemy >=1.3.18,<=1.4.41",
     "peewee >=3.13.3,<4.0.0",
     "databases[sqlite] >=0.3.2,<0.7.0",
     "orjson >=3.2.1,<4.0.0",
@@ -81,7 +83,7 @@ doc = [
     "mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0",
     # TODO: upgrade and enable typer-cli once it supports Click 8.x.x
     # "typer-cli >=0.0.12,<0.0.13",
-    "typer >=0.4.1,<0.7.0",
+    "typer[all] >=0.6.1,<0.7.0",
     "pyyaml >=5.3.1,<7.0.0",
 ]
 dev = [

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():