85b32f51ff
🌐 Initialize new language Polish for translations ( #3170 )
...
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2021-05-10 09:27:07 +02:00
73021d7261
📝 Update social links: add Discord, fix GitHub ( #2621 )
2021-01-09 21:54:38 +01:00
e2a6341c60
📝 Update Uvicorn installation instructions to use uvicorn[standard] (includes uvloop) ( #2543 )
2020-12-19 21:30:18 +01:00
9f89399f5e
🌐 Add docs lang selector widget ( #2542 )
...
* ✨ Add language selector widget
* 🔧 Update script to re-generate MkDocs configs, including langs widget
* 🔧 Update languages MkDocs configs, with lang selector widget
2020-12-19 20:54:02 +01:00
6e9b771abf
🐛 Fix docs overrides directory for translations ( #2541 )
...
* 🙈 Add .gitignore files to keep overrides directories for translations to fix serving live locally during translations
* ♻️ Refactor docs scripts to handle language overrides (newsletter notification)
2020-12-19 19:54:54 +01:00
7a2c5526d4
🌐 Start translation of the documentation for the Albanian language ( #2516 )
2020-12-19 15:05:49 +01:00
e6f8aa8756
✨ Add newsletter: FastAPI and friends ( #2509 )
...
* ✨ Add newsletter: FastAPI and friends
* 🔧 Update MkDocs config for announcement
* 🔧 Update generation script to include overrides for announcements
2020-12-13 16:33:46 +01:00
4bcdbc5673
✨ Set up and enable Material for MkDocs Insiders for the docs ( #2325 )
...
* ⬆️ Upgrade Material for MkDocs
* ⬆️ Install Material for MkDocs Insiders on CI
* 🔧 Update MkDocs configs to use Material for MkDocs Insiders
* ✨ Use the lightbulb because it looks nice 💡
* 💚 Fix GitHub Action workflow syntax for building docs
* 🐛 Fix GitHub Actions workflow syntax, strike one ⚾
2020-11-08 12:42:55 +01:00
ac99792762
✨ Add Discord chat ( #2322 )
...
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2020-11-07 21:48:25 +01:00
8355832c7c
📝 Update/fix links in docs to use HTTPS ( #2165 )
...
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-11-05 23:39:09 +01:00
a42c690496
📝 Add deployment to Deta, the first gold sponsor 🎉 ( #2303 )
...
* 📝 Add docs for sponsors
* 📝 Add docs for deploying on Deta
* 🍱 Add Deta docs screenshots
* ♻️ Refactor and separate deployment docs
* 📝 Update internal docs links to Deployment
* 📝 Update links in Deta tutorial
* 🍱 Update sponsors images
* 🔧 Use sponsors data from YAML
* 📝 Update sponsors in languages docs
* ✨ Update docs generation scripts
* ✅ Update README.md testing
* 📝 Update main README
* 🔧 Update fastapi-people action handling individual sponsors
* ✏️ Fix typos in Deta tutorial
2020-11-05 21:50:37 +01:00
e9413f2711
✏ Fix typo in Spanish tutorial index ( #2020 )
2020-10-18 07:28:44 +02:00
c8365bd339
🌐 Initialize new language Korean for translations ( #2018 )
2020-10-15 07:21:41 +02:00
be669059fb
🎨 Simplify docs hl_lines ranges and standardize 2 spaces between each range ( #1863 )
2020-08-29 16:02:58 +02:00
e1e8627168
🌐 Add Japanese translation for index.md ( #1571 )
2020-08-29 15:34:08 +02:00
60aa63b68a
🌐 Initialize translations for French ( #1975 )
...
Co-authored-by: JulianMaurin <julian.maurin.perso@pm.me>
2020-08-29 14:27:34 +02:00
4f0a3a9e4d
🌐 Initialize Turkish translations ( #1905 )
2020-08-29 11:43:29 +02:00
272f01a153
🌐 Add Ukrainian language setup, without index translation ( #1830 )
2020-08-03 18:04:05 +02:00
d71e807401
💄 Use OS preference theme for docs ( #1760 )
2020-07-22 08:30:12 +02:00
8bafe2a482
🚀 GitHub Actions update, use commit from PR, not pre-merge ( #1761 )
...
* 🔥 Remove deploy badge that won't show correctly until next release
after the fixes to the Gitter bot
* 🐛 Fix GitHub Action to upload docs artifacts with commit from PR, not pre-merge
* ♻️ Run zip docs and artifact upload only on PRs
2020-07-21 23:08:14 +02:00
e7be5c8ac5
💄 Update badges, remove Travis ( #1736 )
...
* 💄 Update badges
* 🔥 Remove Travis
2020-07-19 14:09:55 +02:00
135704dcc8
🐛 Re-enable search bar after adding markdown-data plugin ( #1703 )
2020-07-10 19:45:47 +02:00
a5c03ba1b7
✨ External links in docs with data file ( #1701 )
...
* ➕ Add mkdocs-markdownextradata-plugin for docs
* 🔧 Update MkDocs config file(s) to include external data
* ✨ Add external links data file
* 📝 Use external data file in External Links
* ♻️ Update data files for langs
The cost is some duplication 😔 , these files are updated by the script, but to be able to serve locally they have to be duplicated
* ✨ Update docs script to copy data files
* 🔥 Remove needed duplication of data files for live docs in translations
2020-07-10 14:31:44 +02:00
1f01ce9615
📝 Use Optional in docs ( #1644 )
...
* Updated .py files with Optional tag (up to body_nested_models)
* Update optionals
* docs_src/ all updates, few I was unsure of
* Updated markdown files with Optional param
* es: Add Optional typing to index.md
* Last of markdown files updated with Optional param
* Update highlight lines
* it: Add Optional typings
* README.md: Update with Optional typings
* Update more highlight increments
* Update highlights
* schema-extra-example.md: Update highlights
* updating highlighting on website to reflect .py changes
* Update highlighting for query-params & response-directly
* Address PR comments
* Get rid of unnecessary comment
* ⏪ Revert Optional in Chinese docs as it probably also requires changes in text
* 🎨 Apply format
* ⏪ Revert modified example
* ♻️ Simplify example in docs
* 📝 Update OpenAPI callback example to use Optional
* ✨ Add Optional types to tests
* 📝 Update docs about query params, default to using Optional
* 🎨 Update code examples line highlighting
* 📝 Update nested models docs to use "type parameters" instead of "subtypes"
* 📝 Add notes about FastAPI usage of None
including:
= None
and
= Query(None)
and clarify relationship with Optional[str]
* 📝 Add note about response_model_by_alias
* ♻️ Simplify query param list example
* 🔥 Remove test for removed example
* ✅ Update test for updated example
Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com>
Co-authored-by: yk396 <yk396@cornell.edu>
Co-authored-by: Kai Chen <kaichen120@gmail.com>
2020-06-28 20:13:30 +02:00
0d73b9ff1c
🔧 Add basic setup for Russian translations ( #1566 )
2020-06-13 12:26:15 +02:00
2d9bb64047
🌐 Generated new translation directory to support Italian docs ( #1557 )
...
* Generated new translation directory to support Italian docs
* ⬆️ Upgrade/pin pytest to >= 5.4.3
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-12 18:53:52 +02:00
b0414b9929
📝 Add new links ( #1467 )
...
* 📝 Update opinions including Netflix and add format
* 📝 Add new external links
* 📝 Update README
2020-05-24 08:48:09 +02:00
22f7eae3f2
✏️ Make sure the * in the README is consistent in the docs ( #1424 )
2020-05-17 12:28:37 +02:00
f8f0a6e462
✏️ Fix typos in async docs ( #1423 )
2020-05-17 12:11:17 +02:00
741de7f927
🌐 Add Spanish translation for Concurrency and async / await ( #1290 )
...
* final touches to async section ES translation
* minor fixes
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* Update docs/es/docs/async.md
Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
* 📝 Update async/await docs in EN with emojis
* 📝 Update wording, format, and emojis for async/await in ES
* 🔧 Add async.md to MkDocs for Spanish
Co-authored-by: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-16 20:53:40 +02:00
046d6b7fa0
🌐 Add Spanish translation for advanced/index.md ( #1250 )
...
* spanish translation for advanced/index.md
* Ajustes sugeridos
* ✏️ Capitalize docs title
* 🔧 Add config to MkDocs for spanish
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-16 14:58:00 +02:00
761e5ff01d
🐛 Fix Spanish MkDocs title
2020-05-16 13:05:21 +02:00
9812684178
🌐 Add Spanish translation for the tutorial-user-guide index page ( #1244 )
...
* Spanish translation for the tutorial-user-guide index page
* Improve some parts of the text in terms of writing
* Change the wording to keep the documentation consistent.
* 📝 Add small wording and consistency changes
* 🎨 Apply the same consistency changes to EN 🤷
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-16 13:02:20 +02:00
bd1e85a8d3
📝 Add Spanish translation for the Python Types Intro page ( #1237 )
...
* Spanish translation Python Types Intro page
* 📝 Fix tuple docs in Types intro
* ✏️ Fix typos and wording nitpicks
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-11 19:20:32 +02:00
a7b4c73663
📝 Add Spanish translation for the Features page ( #1220 )
...
* Spanish translation for the Features page
* ✏️ Fix small typos and wording nitpicks
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-11 18:46:46 +02:00
483bce3ae1
⬆️ Upgrade to MkDocs Material 5 and update docs scripts ( #1225 )
...
* ⬆️ Upgrade mkdocs.yml configs for MkDocs Material 5
* ✨ Update docs.py to always update mkdocs.yml
* 🌐 Update mkdocs.yml for translations
* 🔧 Update MkDocs config
* ✨ Add tabs for alternative options
* ⬆️ Update termynal setup with new CSS classes
* 🔧 Sync / Update mkdocs.yml for languages
2020-04-08 06:25:01 +02:00
651ee5e4d2
🎨 Update log style in main page, for GitHub Markdown compatibility ( #1200 )
...
* Update README.md
fix string format
* 🎨 Update log style in main page, for GitHub Markdown compatibility
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-04 22:13:55 +02:00
0a77c613b0
🌐 Add new language on docs: pt ( #1210 )
2020-04-04 22:01:19 +02:00
3a0c22ce7d
🌐 Translate index to Spanish ( #1201 )
2020-04-02 07:00:50 +02:00
eb6be1d725
💬 Add new language of docs: zh ( #1187 )
2020-03-30 20:14:58 +02:00
53a7798e58
🎨 Update badge for coverage ( #1175 )
...
from shields.io, as Codecov's one shows coverage for the last PR from a fork at master
2020-03-27 17:51:58 +01:00
6205935323
✨ Add support for docs translations ( #1168 )
...
* 🌐 Refactor file structure to support internationalization
* ✅ Update tests changed after i18n
* 🔀 Merge Typer style from master
* 🔧 Update MkConfig with Typer-styles
* 🎨 Format mkdocs.yml with cannonical form
* 🎨 Format mkdocs.yml
* 🔧 Update MkDocs config
* ➕ Add docs translation scripts dependencies
* ✨ Add Typer scripts to handle translations
* ✨ Add missing translation snippet to include
* ✨ Update contributing docs, add docs for translations
* 🙈 Add docs_build to gitignore
* 🔧 Update scripts with new locations and docs scripts
* 👷 Update docs deploy action with translations
* 📝 Add note about languages not supported in the theme
* ✨ Add first translation, for Spanish
2020-03-26 20:09:53 +01:00
neternefer
Sebastián Ramírez
vjanz
谭九鼎
Juan Sebastian Avila Rodriguez
hard_coder
Brock Friedrich
ryuckel
JulianMaurin
Yağızcan Değirmenci
Adrien Cacciaguerra
Cesare De Cal
Alvaro Pernas
Juan Funez
MartinEliasQ
Camila Gutierrez
Gao Chao
Cássio Botaro
Ikkyu