51d3a8ff12
🔨 Add MkDocs hook that renames sections based on the first index file ( #9737 )
2023-06-24 16:47:15 +02:00
c09e5cdfa7
👷 Refactor Docs CI, run in multiple workers with a dynamic matrix to optimize speed ( #9732 )
2023-06-24 02:00:12 +02:00
7167c77a18
⬆️ Upgrade and fully migrate to Ruff, remove isort, includes a couple of tweaks suggested by the new version of Ruff ( #9660 )
2023-06-12 00:37:34 +02:00
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
392766bcfa
✏ Update `zip-docs.sh` internal script, remove extra space ( #5931 )
2023-02-09 20:36:46 +01:00
9efab1bd96
👷 Refactor CI artifact upload/download for docs previews ( #5793 )
2022-12-16 22:11:03 +04:00
884203676d
👷 Tweak build-docs to improve CI performance ( #5699 )
2022-11-27 14:22:30 +00:00
fa74093440
✨ Use Ruff for linting ( #5630 )
2022-11-13 19:19:04 +01:00
be3e29fb3c
👷 Switch from Codecov to Smokeshow plus pytest-cov to pure coverage for internal tests ( #5583 )
2022-11-03 21:00:29 +01:00
e866a2c7e1
🐛 Fix calling `mkdocs` for languages as a subprocess to fix/enable MkDocs Material search plugin ( #5501 )
...
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-10-16 17:01:38 +02:00
eb1d68c789
🔧 Lint only in Python 3.7 and above ( #4006 )
2021-10-06 15:08:57 +00:00
ae22bca9fe
⬆️ Upgrade development `autoflake`, supporting multi-line imports ( #3988 )
2021-10-05 10:17:31 +00:00
fa2c750443
✅ Add the `docs_src` directory to test coverage and update tests ( #1904 )
...
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2021-07-29 11:26:07 +02:00
273b2cd646
🐛 Fix docs script to generate a new translation language with overrides boilerplate ( #3202 )
2021-05-10 09:15:39 +02:00
da86791224
✨ Add new Deta banner badge with new sponsorship tier 🙇 ( #3194 )
2021-05-08 19:50:56 +02: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
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
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
e1755f4fa6
🔥 Cleanup after upgrade for Docs Previews GitHub Action ( #2248 )
...
* 🔧 Upload docs artifacts even on push to avoid breaking Preview Docs
* 🔥 Remove replaced GitHub Action get-artifact
* 🔥 Remove GitHub Action Watch Docs Previews, replaced with Preview Docs
* 🔥 Remove commented backup configs in Preview Docs GitHub Action
* 🔥 Remove no longer needed utils scripts
2020-10-25 19:46:32 +01:00
f88ffd1a0b
⚡ ️ Build docs for languages in parallel in subprocesses to speed up CI ( #2242 )
2020-10-25 12:59:13 +01:00
8650dee4bc
🐛 Fix docs order generation for partial translations ( #2238 )
2020-10-24 13:32:59 +02:00
da9b5201c4
🔧 Add Flake8 linting ( #1774 )
...
Co-authored-by: nimashadix <nimashadix@pop-os.localdomain>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-09 12:54:05 +02:00
aedf5c895a
👷 Re-enable Gitter releases bot ( #1831 )
2020-08-03 19:28:02 +02:00
6ab2841dbb
♻ Update GitHub actions ( #1746 )
...
* 🐛 Fix Gitter notification, use development gitter room until next release
* 🔥 Remove trigger docs preview step from build-docs workflow
as it requires a more privileged token, so it's now triggered by the preview docs watcher
* 🔊 Dump context when building to allow debugging how to refactor the Gitter bot
2020-07-20 18:56:13 +02:00
7032dfb4f1
✨ Add GitHub Action to watch for missing preview docs ( #1740 )
...
* 📝 Update release notes
* 🔊 Make curl verbose when triggering docs preview
* 🔧 Update GitHub Actions circus to use commit hash
* ✨ Add PR docs preview watcher
2020-07-20 16:33:17 +02:00
b268c39758
✨ Add internal GitHub action to deploy docs previews ( #1739 )
...
* 📝 Update release notes
* ✨ Add internal GitHub action to pull docs artifact
* 🙈 Add archive.zip to gitignore
2020-07-19 22:11:28 +02:00
4dd386b807
🚀 Preview docs for external PRs ( #1738 )
...
* 🍱 Save docs zip when building docs
* 🙈 Add docs.zip artifact to .gitignore
* 🚀 Update deploy artifact name
* ♻️ Upload artifact directory
* ✨ Add WIP trigger docs preview
* ♻️ Update trigger docs preview
* 👷 Update env vars for docs preview
* 👷 Update PR extraction
* 👷 Try to show GitHub event
* 💚 Try to see if GitHub context templates is causing the problem
* 💚 Try to debug context GitHub event
* 🔊 Debug GitHub event context
* 👷 Update debugging action
* 👷 Update debug
* 👷 Update Action
* ♻️ Update script to trigger docs preview
* ⚡ ️ Try to use Zip again to improve speed
* 🔧 Update zip scripts
* ✨ Add preview docs on event
* 🚀 Trigger deploy preview on PRs
* 🐛 Fix trigger script env vars
2020-07-19 20:49:52 +02:00
780d3e65ad
✅ Add XML coverage report for GitHub Actions ( #1737 )
2020-07-19 14:24:24 +02:00
47a630721a
👷 Add GitHub Actions, move from Travis ( #1735 )
2020-07-19 14:03:38 +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
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
fe453f80ed
⬆ Upgrade isort to version 5.x.x ( #1670 )
...
* Update isort script to match changes in the new release, isort v5.0.2
* Downgrade isort to version v4.3.21
* Add an alternative flag to --recursive in isort v5.0.2
* Add isort config file
* 🚚 Import from docs_src for tests
* 🎨 Format dependencies.utils
* 🎨 Remove isort combine_as_imports, keep black profile
* 🔧 Update isort config, use pyproject.toml, Black profile
* 🔧 Update format scripts to use explicit directories to format
otherwise it would try to format venv env directories, I have several with different Python versions
* 🎨 Format NoSQL tutorial after re-sorting imports
* 🎨 Fix format for __init__.py
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-07-09 20:06:12 +02:00
5984233223
🐛 Fix Enum handling with their own schema definitions ( #1463 )
...
* 🐛 Fix extra support for enum with its own schema
* ✅ Fix/update test for enum with its own schema
* 🐛 Fix type declarations
* 🔧 Update format and lint scripts to support locally installed Pydantic and Starlette
* 🐛 Add temporary type ignores while enum schemas are merged
2020-05-23 18:56:18 +02:00
e4f0947821
✨ Allow Unicode in MkDocs for translations instead of escaped chars ( #1419 )
2020-05-16 15:17:24 +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
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
06eaa32bf0
🔧 Update docs script to make sure languages are always sorted ( #1189 )
2020-03-30 20:41:50 +02:00
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
7625e1e386
📝 Update and simplify translations docs ( #1171 )
2020-03-27 10:20:39 +01:00
c13b54ad0e
🏁 Change docs address to localhost for Windows ( #1169 )
2020-03-26 22:22:34 +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
1da8d3f1e6
🔧 Move all mypy configurations to configuration file ( #987 )
2020-02-27 21:03:03 +01:00
9573130630
✅ Lint first in tests, to error out faster ( #948 )
2020-02-04 05:41:42 +01:00
e5d7878856
➖ Use venv with Flit for local development, instead of requiring Flit and Pipenv ( #877 )
2020-01-17 09:51:03 +01:00
7b3319ddab
✏️ Tweak typos and configs ( #837 )
2020-01-08 23:25:29 +01:00
dcc1e1bcf8
♻️ Refine internal type declarations and logic around them ( #338 )
2019-06-27 20:51:17 +02:00
a33c299fd7
🔧 Add format-imports script
2019-06-13 18:38:49 +02:00
fcaff64646
🔧 Separate format and lint scripts ( #232 )
2019-05-15 22:13:06 +04:00
95475aaa9c
🔥 Remove Python version extraction in tests, no longer used
2019-05-15 18:33:13 +04:00
7a8b054a12
🎨 Reenable Black --check for Python 3.7 ( #229 )
...
Reenabled Black --check for python 3.7, issue is fixed.
see https://github.com/ambv/black/issues/494
2019-05-15 18:29:36 +04:00
5f13b53ea5
🔧 Enable FastAPI releases bot in main Gitter channel
2019-05-11 19:44:39 +04:00
6ff89284c5
✨ Add FastAPI releases bot for Gitter ( #189 )
...
* 🔥 Remove development util script
* 🎨 Reformat release notes with markdown-only code (no HTML)
* ✨ Add FastAPI releases bot for Gitter
2019-04-27 20:02:32 +04:00
ffc4c716c0
🚀 Make Flit publish from CI ( #170 )
2019-04-20 22:09:35 +04:00
907e613ff2
🔧 Update test-conv-html.sh to allow extra params
2019-04-05 14:29:36 +04:00
108c2f3c0e
⬆️ Update Pydantic to 0.21.0 ( #90 )
...
* ⬆️ Upgrade Pydantic and others (isort), update docs after changes by isort
* 🎨 Format with newest isort, update type hints in jsonable_encoder
* 🔧 Update test script, to avoid Pydantic type errors
* ⬆️ Update pyproject.toml with latest Pydantic
2019-03-21 18:40:29 +04:00
e8472ebbd1
🔧 Make scripts executable ( #76 )
2019-03-16 21:19:13 +04:00
11c755bee3
✨ Add tags parameter to app.include_router ( #55 )
2019-03-16 21:15:08 +04:00
1112ac7538
⬆️ Update imports and scripts for new isort versions ( #75 )
2019-03-09 15:04:13 +04:00
2caca42b9e
👷 Trigger Docker images build on Travis ( #65 )
2019-03-04 11:12:21 +04:00
955e9fcb31
Update fix SQLAlchemy support with ORM ( #30 )
...
✨ SQLAlchemy ORM support
Improved jsonable_encoder with SQLAlchemy support, tests running with SQLite, improved and updated SQL docs
* ➕ Add SQLAlchemy to development dependencies (not required for using FastAPI)
* ➕ Add sqlalchemy to testing dependencies (not required to use FastAPI)
2019-02-12 23:02:21 +04:00
32438c85f6
Using pydantic custom encoders ( #21 )
...
Add support for Pydantic custom JSON encoders.
2019-02-08 16:06:19 +04:00
23ef570bf6
✅ Add test-cov-html script for local coverage
...
analysis and debugging
2018-12-22 07:42:24 +04:00
0a65c41909
📝 Move tutorial src files to top level docs
2018-12-21 16:22:33 +04:00
7da9625505
💚 Revert to flit install and re-format
...
As it has shown to be more reliable, and closer to final user environments
2018-12-18 22:36:04 +04:00
bcb967f98a
💚 Try fixing Travis, again...
2018-12-18 22:22:07 +04:00
343ecb7669
💚 Use pipenv in Travis
2018-12-18 22:08:47 +04:00
e9f2a3c291
✨ Update tutorial renamer to exclude files
2018-12-18 21:59:51 +04:00
00e2e544c7
♻️ Re-format tutorials, files names and tests
...
for tutorial files
2018-12-18 21:59:06 +04:00
786c392bd5
💚 Fix Netlify build with pipenv
2018-12-17 18:56:48 +04:00
acc15230ea
✅ Update query tests, application type checks
...
and temporarily disable coverage fail, to allow publishing docs from Travis
2018-12-17 15:48:38 +04:00
a84960b13d
💚 Update Netlify docs build, try 78
2018-12-15 22:16:54 +04:00
10134803a9
💚 Call docs build with Python module
2018-12-15 22:10:12 +04:00
8d29a28f82
📝 Update docs, stubs and structure
2018-12-15 21:52:28 +04:00
f8f91a1dbb
📝 Add stub for extra Starlette
2018-12-15 21:45:57 +04:00
2b64dc699e
✨ Update tutorial src renamer to use sub-directories
2018-12-14 14:27:52 +04:00
ec7bec32ba
🎨 Update renamer script
2018-12-14 10:06:20 +04:00
d9fbead646
🎨 Remove un-used imports, add auto-flake
2018-12-13 21:48:03 +04:00
f539217b5b
🚚 Script to auto-resort tutorial src files
2018-12-13 21:26:30 +04:00
211930c108
📝 Fix live docs script
2018-12-12 18:28:24 +04:00
b986671800
💚 Try again with Netlify, different settings
2018-12-10 08:22:06 +04:00
61fdebabc9
💚 Add build docs script
2018-12-10 08:08:08 +04:00
73307e9994
📝 Add docs, set up mkdocs
2018-12-10 07:59:18 +04:00
ea8b1a50f1
✅ Error out when tests fail
2018-12-09 19:56:37 +04:00
12dbc17583
👷 Add scripts, stolen from Starlette
2018-12-08 11:58:24 +04:00
Sebastián Ramírez
Jakepys
Marcelo Trylesinski
Nima Mashhadi M. Reza
Brian Mboya
duganchen
Camila Gutierrez
Taneli Hukkinen
zamiramir
euri10