Commit Graph

31 Commits

Author SHA1 Message Date
Alejandra 2eca83fbda
📝 Update contributing guidelines for installing requirements (#14095) 2025-09-21 13:29:04 +02:00
Alejandra 3d60b5e23e
📝 Add discussion template for new language translation requests (#13535)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2025-07-26 11:35:42 +00:00
Motov Yurii 2c13b1ba4b
📝 Add notification about impending changes in Translations to `docs/en/docs/contributing.md` (#13886) 2025-07-11 18:14:15 +02:00
Subin Lee abac475407
✏️ Fix error in `docs/en/docs/contributing.md` (#12899) 2024-12-25 20:32:56 +00:00
Sebastián Ramírez 8767a31c80
📝 Update `contributing.md` docs, include note to not translate this page (#12841) 2024-11-10 17:11:56 +00:00
Sebastián Ramírez 7fb9c5922d
📝 Fix admonition double quotes with new syntax (#12835)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-11-09 16:39:20 +00:00
Sebastián Ramírez bd1b77548f
📝 Update docs about serving FastAPI: ASGI servers, Docker containers, etc. (#12069) 2024-08-25 02:44:06 +00:00
Sebastián Ramírez 705659bb22
📝 Add docs about Environment Variables and Virtual Environments (#12054) 2024-08-21 19:47:31 -05:00
Sebastián Ramírez c82497f78e
📝 Update docs section about "Don't Translate these Pages" (#12022) 2024-08-15 10:21:25 -05:00
Sebastián Ramírez 85bd4067c2
📝 Add documentation for non-translated pages and scripts to verify them (#12020) 2024-08-14 17:57:10 -05:00
Sebastián Ramírez b0a8e7356a
📝 Update admonitions in docs missing (#11998) 2024-08-12 16:47:53 -05:00
Sebastián Ramírez 0cd844d387
🔧 Update docs setup with latest configs and plugins (#11953) 2024-08-05 23:48:30 -05:00
Sebastián Ramírez 221e59b0d1
🚚 Rename GitHub links from tiangolo/fastapi to fastapi/fastapi (#11913) 2024-07-29 18:35:07 -05:00
Nils Lindemann 0380ca3e69
📝 Review and rewording of `en/docs/contributing.md` (#10480)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-01-11 21:42:43 +04:00
Alejandra 8b5843ebcd
📝 Restructure Docs section in Contributing page (#10844)
📝 Restructure Docs section in Contributing page
2023-12-26 18:13:50 +01:00
Vicente Merino 0b496ea1f8
📝 Fix typo in `docs/en/docs/contributing.md` (#9878)
Co-authored-by: Vicente Merino <vmerino@rexmas.com>
2023-08-05 10:34:07 +02:00
Sebastián Ramírez 5656ed09ef
Refactor docs for building scripts, use MkDocs hooks, simplify (remove) configs for languages (#9742)
*  Add MkDocs hooks to re-use all config from en, and auto-generate missing docs files form en

* 🔧 Update MkDocs config for es

* 🔧 Simplify configs for all languages

*  Compute available languages from MkDocs Material for config overrides in hooks

* 🔧 Update config for MkDocs for en, to make paths compatible for other languages

* ♻️ Refactor scripts/docs.py to remove all custom logic that is now handled by the MkDocs hooks

* 🔧 Remove ta language as it's incomplete (no translations and causing errors)

* 🔥 Remove ta lang, no translations available

* 🔥 Remove dummy overrides directories, no longer needed

*  Use the same missing-translation.md file contents for hooks

* ️ Restore and refactor new-lang command

* 📝 Update docs for contributing with new simplified workflow for translations

* 🔊 Enable logs so that MkDocs can show its standard output on the docs.py script
2023-06-25 14:33:58 +02:00
Sebastián Ramírez 6595658324
⬇️ Separate requirements for development into their own requirements.txt files, they shouldn't be extras (#9655) 2023-06-11 23:38:15 +02:00
MariiaRomaniuk 055cf356ca
✏ Fix command to install requirements in Windows (#9445)
fix command to install requirements
2023-05-01 23:27:49 -07:00
zhangbo 22524a1610
✏ Fix typo in docs about contributing, for compatibility with `pip` in Zsh (#5523)
Co-authored-by: zhangbo <zhangbo@zjptmc.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-10-31 16:46:37 +00:00
Ofek Lev 4267bd1f4f
🔧 Update package metadata, drop support for Python 3.6, move build internals from Flit to Hatch (#5240)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-09-14 20:31:19 +02:00
Edwuin Gutierrez b3f2f08251
📝 Add step about upgrading pip in the venv to avoid errors when installing dependencies `docs/en/docs/contributing.md` (#5181)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-08-26 14:26:28 +00:00
Nina Hwang 4ba1e81f16
✏ Fix typo in file paths in `docs/en/docs/contributing.md` (#3752)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2021-10-07 17:44:46 +02:00
Sebastián Ramírez ae22bca9fe
⬆️ Upgrade development `autoflake`, supporting multi-line imports (#3988) 2021-10-05 10:17:31 +00:00
Sebastián Ramírez 600f15faa0
✔ Improve support for tests in editor (#1699)
* ♻️ Remove required extra steps to test in editor

* 🎨 Format lint script

* 📝 Remove obsolete extra steps required to test in editor from docs

* 🐛 Fix coverage
2020-07-10 11:08:19 +02:00
Sebastián Ramírez 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
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 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 7625e1e386
📝 Update and simplify translations docs (#1171) 2020-03-27 10:20:39 +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 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