Commit Graph

3805 Commits

Author SHA1 Message Date
Sebastián Ramírez 8d92557e53 📝 Update relase notes 2020-04-05 16:47:33 +02:00
Mickey Pashov c56342bf79
✏️ Fix minor grammatical mistakes in the async docs (#1188)
* Fix minor grammatical mistakes in the async docs.

* ✏️ Update wording and clarify with emojis

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 16:46:22 +02:00
Harsha Laxman 07e094fd50
📝 Add note about Alembic in project generator in SQL docs (#1183)
* Update sql-databases alembic docs

Was helpful to refer to the full-stack project when integrating alembic into my own project

* 📝 Update Alembic note in docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 15:15:39 +02:00
Sebastián Ramírez 1cc30de32f 📝 Update release notes 2020-04-05 15:07:00 +02:00
Sebastián Ramírez 766157bfb4 📝 Update release notes 2020-04-05 13:57:45 +02:00
duganchen d96223460b
📝 Add an example of setting up a test database (#1144)
* Add an example of setting up a test database.

* 📝 Add/update docs for testing a DB with dependency overrides

* 🔧 Update test script, remove line removing test file as it is removed during testing

*  Update testing coverage pragma

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 13:53:09 +02:00
Sebastián Ramírez fd99dfc95b 📝 Update release notes 2020-04-04 22:38:17 +02:00
Sebastián Ramírez 10fb7ace04
📝 Update contributing guidelines to review translation PRs (#1215) 2020-04-04 22:36:10 +02:00
Sebastián Ramírez a1a19b103c 📝 Update release notes 2020-04-04 22:16:12 +02:00
Sebastián Ramírez 5c111caf40 📝 Update release notes 2020-04-04 22:14:55 +02:00
Gao Chao 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
Cássio Botaro 0a77c613b0
🌐 Add new language on docs: pt (#1210) 2020-04-04 22:01:19 +02:00
Sebastián Ramírez 70bc469373 📝 Update release notes 2020-04-04 21:39:52 +02:00
Sebastián Ramírez b76334f544
📝 Settings using lru_cache (#1214)
*  Update settings examples to use lru_cache

* 📝 Update docs for Settings, using @lru_cache

* 🎨 Update lru_cache colors to show difference in stored values
2020-04-04 21:39:15 +02:00
Sebastián Ramírez 14b467db06 📝 Update release notes 2020-04-02 07:03:00 +02:00
Sebastián Ramírez 3b7e4e0544 📝 Update release notes 2020-04-02 06:59:19 +02:00
alexmitelman d4d5b21b2e
📝 Add documentation about settings and env vars (#1118)
* Add doc and example for env var config

* Syntax highlight for .env file

* Add test for configuration docs

* 📝 Update settings docs, add more examples

*  Add tests for settings

* 🚚 Rename "Application Configuration" to "Metadata and Docs URLs"

to disambiguate between that and settings

* 🔥 Remove replaced example file

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-02 06:55:20 +02:00
Sebastián Ramírez 6e1cd45a46 🔖 Release version 0.53.2 2020-03-30 21:49:50 +02:00
Sebastián Ramírez b86d130eb6 📝 Update release notes 2020-03-30 21:47:11 +02:00
Sebastián Ramírez 042c697b6b 📝 Update release notes 2020-03-30 20:49:24 +02:00
Sebastián Ramírez 210af1fd3d 📝 Update release notes 2020-03-30 20:42:46 +02:00
Sebastián Ramírez 4f88a5fddb 📝 Update release notes 2020-03-30 20:26:07 +02:00
Ikkyu eb6be1d725
💬 Add new language of docs: zh (#1187) 2020-03-30 20:14:58 +02:00
Sebastián Ramírez 1d99681fd4 📝 Update release notes 2020-03-30 12:01:30 +02:00
Sebastián Ramírez 544afaff97
📝 Add docs for adding example to schema (#1185) 2020-03-30 11:58:48 +02:00
Sebastián Ramírez e6b3b994be 🔖 Release version 0.53.1 2020-03-29 22:08:54 +02:00
Sebastián Ramírez 67f148ff83 📝 Update release notes 2020-03-29 22:06:02 +02:00
Sebastián Ramírez 6c34600599
🐛 Fix include docs example file (#1182) 2020-03-29 22:05:24 +02:00
John Paton 016a4b7491
📝 Add documentation of example kwarg of Field (#1106)
* Add documentation of example kwarg of Field

* 📝 Update info about schema examples

* 🚚 Move example file to new directory

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-29 21:43:31 +02:00
Sebastián Ramírez be21b74ad5 📝 Update release notes 2020-03-29 19:28:53 +02:00
Sebastián Ramírez 0d165d1efa 📝 Update release notes 2020-03-29 18:52:33 +02:00
YangQuan 9d54215a3a
📝 Add example of Pycharm in tutorial/debugging.md (#1096)
* add example of pycharm in tutorial/debugging.md

* 📝 Update PyCharm debug instructions and screenshot

* 🚚 Move image to new location in docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-29 18:50:29 +02:00
Sebastián Ramírez 8ab916baed 📝 Update release notes 2020-03-29 17:53:49 +02:00
Paul-Louis NECH c83c50b27d
✏️ Fix typo (#1148) 2020-03-29 17:51:58 +02:00
Sebastián Ramírez c2ad214a84 📝 Update release notes 2020-03-29 17:05:03 +02:00
Sebastián Ramírez 459f0e11e5
🏁 Update Windows development environment and tests (#1179)
* 🏁 Fix ./scripts/docs.py encoding for Windows

* 🔥 Remove ujson from tests as it prevents Windows development

It's still tested by Starlette anyway

* 📝 Update development instructions for Windows

* 🎨 Update format for WSGIMiddleware example

*  Update tests to run on Windows
2020-03-29 17:04:04 +02:00
Sebastián Ramírez 56e43ba204 🔖 Release version 0.53.0 2020-03-27 17:56:41 +01:00
Sebastián Ramírez 10485cad5a 📝 Update release notes 2020-03-27 17:52:33 +01:00
Sebastián Ramírez 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
Sebastián Ramírez 372ed58677 📝 Update release notes 2020-03-27 17:33:51 +01:00
Sebastián Ramírez 02a6fcad98 📝 Update release notes 2020-03-27 17:29:11 +01:00
Ari Bajo 651ced68bf
🐛 Fix GZipMiddleware code block linking to TrustedHostMiddleware in docs (#1138) 2020-03-27 17:27:57 +01:00
Sebastián Ramírez 670b64360d 📝 Update release notes 2020-03-27 17:20:01 +01:00
Sebastián Ramírez d1f067dc5b 📝 Update release notes 2020-03-27 17:16:45 +01:00
Sebastián Ramírez 38fd8a674b 📝 Update release notes 2020-03-27 17:04:25 +01:00
Ben bd37d8d04f
📝 Add new external link (#1112)
* Added new external link

I added an article in which I briefly explain how to build an Apache Kafka producer / consumer with FastAPI and aiokafka.

* 📝 Update format

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-27 17:02:18 +01:00
Sebastián Ramírez bc99ad0ad1 📝 Update release notes 2020-03-27 16:21:28 +01:00
Sebastián Ramírez 869c7389e2 📝 Update release notes 2020-03-27 15:34:16 +01:00
Aakash Nand 2738df3801
Add Gitter chat to docs (#1061)
* implemented chat feature using sidecar from starlette docs

* 🔥 Use external Gitter sidecar JS

*  Re-implement Gitter chat after multi-lang

* 🔥 Remove moved file

Co-authored-by: Aakash Nand <aakashnand@nttv6.jp>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-27 15:32:15 +01:00
Sebastián Ramírez 433d7862ea 📝 Update release notes 2020-03-27 10:21:40 +01:00
Sebastián Ramírez 7625e1e386
📝 Update and simplify translations docs (#1171) 2020-03-27 10:20:39 +01:00
Sebastián Ramírez 53e773a2e1 📝 Update release notes 2020-03-26 22:24:36 +01:00
Camila Gutierrez c13b54ad0e
🏁 Change docs address to localhost for Windows (#1169) 2020-03-26 22:22:34 +01:00
Sebastián Ramírez 71c2abb41d 📝 Update release notes 2020-03-26 20:13:03 +01:00
Sebastián Ramírez 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