library/docs-fastapi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync fastapi docs from d3e6a293 on 2026-06-11

Browse Source
This commit is contained in:
The Librarian
2026-06-11 04:00:10 +00:00
parent dc0739b455
commit 2c5483ee1c
231 changed files with 2503 additions and 4501 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/mkdocs.yml
+27 -51
View File
@@ -1,10 +1,10 @@
INHERIT: ../en/mkdocs.env.yml
site_name: FastAPI
site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production
site_url: https://fastapi.tiangolo.com/
theme:
variant: classic
name: material
custom_dir: ../en/overrides
custom_dir: overrides
palette:
- media: (prefers-color-scheme)
toggle:
@@ -45,38 +45,13 @@ theme:
- search.suggest
- toc.follow
icon:
repo: fontawesome/brands/github-alt
repo: octicons/mark-github-24
logo: img/icon-white.svg
favicon: img/favicon.png
language: en
repo_name: fastapi/fastapi
repo_url: https://github.com/fastapi/fastapi
plugins:
social:
cards_layout_options:
logo: ../en/docs/img/icon-white.svg
typeset: null
search: null
macros:
include_yaml:
- github_sponsors: ../en/data/github_sponsors.yml
- people: ../en/data/people.yml
- contributors: ../en/data/contributors.yml
- translators: ../en/data/translators.yml
- translation_reviewers: ../en/data/translation_reviewers.yml
- skip_users: ../en/data/skip_users.yml
- members: ../en/data/members.yml
- sponsors_badge: ../en/data/sponsors_badge.yml
- sponsors: ../en/data/sponsors.yml
- topic_repos: ../en/data/topic_repos.yml
redirects:
redirect_maps:
deployment/deta.md: deployment/cloud.md
advanced/graphql.md: how-to/graphql.md
advanced/custom-request-and-route.md: how-to/custom-request-and-route.md
advanced/conditional-openapi.md: how-to/conditional-openapi.md
advanced/extending-openapi.md: how-to/extending-openapi.md
advanced/testing-database.md: how-to/testing-database.md
mkdocstrings:
handlers:
python:
@@ -102,13 +77,13 @@ plugins:
nav:
- FastAPI: index.md
- features.md
- Learn:
- "":
- learn/index.md
- python-types.md
- async.md
- environment-variables.md
- virtual-environments.md
- Tutorial - User Guide:
- "":
- tutorial/index.md
- tutorial/first-steps.md
- tutorial/path-params.md
@@ -137,14 +112,14 @@ nav:
- tutorial/path-operation-configuration.md
- tutorial/encoder.md
- tutorial/body-updates.md
- Dependencies:
- "":
- tutorial/dependencies/index.md
- tutorial/dependencies/classes-as-dependencies.md
- tutorial/dependencies/sub-dependencies.md
- tutorial/dependencies/dependencies-in-path-operation-decorators.md
- tutorial/dependencies/global-dependencies.md
- tutorial/dependencies/dependencies-with-yield.md
- Security:
- "":
- tutorial/security/index.md
- tutorial/security/first-steps.md
- tutorial/security/get-current-user.md
@@ -161,7 +136,7 @@ nav:
- tutorial/static-files.md
- tutorial/testing.md
- tutorial/debugging.md
- Advanced User Guide:
- "":
- advanced/index.md
- advanced/stream-data.md
- advanced/path-operation-advanced-configuration.md
@@ -173,7 +148,7 @@ nav:
- advanced/response-headers.md
- advanced/response-change-status-code.md
- advanced/advanced-dependencies.md
- Advanced Security:
- "":
- advanced/security/index.md
- advanced/security/oauth2-scopes.md
- advanced/security/http-basic-auth.md
@@ -199,7 +174,7 @@ nav:
- advanced/strict-content-type.md
- fastapi-cli.md
- editor-support.md
- Deployment:
- "":
- deployment/index.md
- deployment/versions.md
- deployment/fastapicloud.md
@@ -209,7 +184,7 @@ nav:
- deployment/cloud.md
- deployment/server-workers.md
- deployment/docker.md
- How To - Recipes:
- "":
- how-to/index.md
- how-to/general.md
- how-to/migrate-from-pydantic-v1-to-pydantic-v2.md
@@ -222,7 +197,7 @@ nav:
- how-to/configure-swagger-ui.md
- how-to/testing-database.md
- how-to/authentication-error-status-code.md
- Reference (Code API):
- "":
- reference/index.md
- reference/fastapi.md
- reference/parameters.md
@@ -238,7 +213,7 @@ nav:
- reference/response.md
- reference/responses.md
- reference/middleware.md
- OpenAPI:
- "":
- reference/openapi/index.md
- reference/openapi/docs.md
- reference/openapi/models.md
@@ -248,15 +223,15 @@ nav:
- reference/templating.md
- reference/testclient.md
- fastapi-people.md
- Resources:
- "":
- resources/index.md
- help-fastapi.md
- contributing.md
- translations.md
- project-generation.md
- external-links.md
- newsletter.md
- management-tasks.md
- About:
- "":
- about/index.md
- alternatives.md
- history-design-future.md
@@ -264,10 +239,7 @@ nav:
- management.md
- release-notes.md
markdown_extensions:
material.extensions.preview:
targets:
include:
- '*'
zensical.extensions.macros: null
abbr: null
attr_list: null
footnotes: null
@@ -290,7 +262,10 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format ''
pymdownx.tilde: null
pymdownx.blocks.admonition:
# TODO: remove types section (with custom types) once translations are migrated to
# not use custom types too
types:
# Default types
- note
- attention
- caution
@@ -299,6 +274,7 @@ markdown_extensions:
- tip
- hint
- warning
# Custom types
- info
- check
pymdownx.blocks.details: null
@@ -308,16 +284,16 @@ markdown_extensions:
markdown_include_variants: null
extra:
social:
- icon: fontawesome/brands/github-alt
- icon: octicons/mark-github-24
link: https://github.com/fastapi/fastapi
- icon: fontawesome/brands/discord
link: https://discord.gg/VQjSZaeJmf
- icon: fontawesome/brands/twitter
- icon: fontawesome/brands/x-twitter
link: https://x.com/fastapi
- icon: fontawesome/brands/bluesky
link: https://bsky.app/profile/fastapi.tiangolo.com
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/fastapi
- icon: fontawesome/solid/globe
link: https://tiangolo.com
alternate:
- link: /
name: en - English
@@ -350,5 +326,5 @@ extra_javascript:
- js/termynal.js
- js/custom.js
- js/init_kapa_widget.js
hooks:
- ../../scripts/mkdocs_hooks.py
validation:
unresolved_references: false