mirror of
https://github.com/fastapi/fastapi.git
synced 2026-09-14 13:36:21 +08:00
Sebastián Ramírez
05ca41cfd1
* ➕ Add mkdocstrings and griffe-typingdoc to dependencies * 🔧 Add mkdocstrings configs to MkDocs * 📝 Add first WIP reference page * ⬆️ Upgrade typing-extensions to the minimum version including Doc() * 📝 Add docs to FastAPI parameters * 📝 Add docstrings for OpenAPI docs utils * 📝 Add docstrings for security utils * 📝 Add docstrings for UploadFile * 📝 Update docstrings in FastAPI class * 📝 Add docstrings for path operation methods * 📝 Add docstring for jsonable_encoder * 📝 Add docstrings for exceptions * 📝 Add docstsrings for parameter functions * 📝 Add docstrings for responses * 📝 Add docstrings for APIRouter * ♻️ Sub-class BackgroundTasks to document it with docstrings * 📝 Update usage of background tasks in dependencies * ✅ Update tests with new deprecation warnings * 📝 Add new reference docs * 🔧 Update MkDocs with new reference docs * ✅ Update pytest fixture, deprecation is raised only once * 🎨 Update format for types in exceptions.py * ♻️ Update annotations in BackgroundTask, `Annotated` can't take ParamSpec's P.args or P.kwargs * ✏️ Fix typos caught by @pawamoy * 🔧 Update and fix MkDocstrings configs from @pawamoy tips * 📝 Update reference docs * ✏️ Fix typos found by @pawamoy * ➕ Add HTTPX as a dependency for docs, for the TestClient * 🔧 Update MkDocs config, rename websockets reference * 🔇 Add type-ignores for Doc as the stubs haven't been released for mypy * 🔥 Remove duplicated deprecated notice * 🔇 Remove typing error for unreleased stub in openapi/docs.py * ✅ Add tests for UploadFile for coverage * ⬆️ Upgrade griffe-typingdoc==0.2.2 * 📝 Refactor docs structure * 🔨 Update README generation with new index frontmatter and style * 🔨 Update generation of languages, remove from top menu, keep in lang menu * 📝 Add OpenAPI Pydantic models * 🔨 Update docs script to not translate Reference and Release Notes * 🔧 Add reference for OpenAPI models * 🔧 Update MkDocs config for mkdocstrings insiders * 👷 Install mkdocstring insiders in CI for docs * 🐛 Fix MkDocstrings insiders install URL * ➕ Move dependencies shared by docs and tests to its own requirements file * 👷 Update cache keys for test and docs dependencies * 📝 Remove no longer needed __init__ placeholder docstrings * 📝 Move docstring for APIRouter to the class level (not __init__ level) * 🔥 Remove no longer needed dummy placeholder __init__ docstring
26 lines
673 B
Plaintext
26 lines
673 B
Plaintext
-e .
|
|
-r requirements-docs-tests.txt
|
|
pydantic-settings >=2.0.0
|
|
pytest >=7.1.3,<8.0.0
|
|
coverage[toml] >= 6.5.0,< 8.0
|
|
mypy ==1.4.1
|
|
ruff ==0.0.275
|
|
email_validator >=1.1.1,<3.0.0
|
|
dirty-equals ==0.6.0
|
|
# TODO: once removing databases from tutorial, upgrade SQLAlchemy
|
|
# probably when including SQLModel
|
|
sqlalchemy >=1.3.18,<1.4.43
|
|
databases[sqlite] >=0.3.2,<0.7.0
|
|
orjson >=3.2.1,<4.0.0
|
|
ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,<6.0.0
|
|
python-multipart >=0.0.5,<0.0.7
|
|
flask >=1.1.2,<3.0.0
|
|
anyio[trio] >=3.2.1,<4.0.0
|
|
python-jose[cryptography] >=3.3.0,<4.0.0
|
|
pyyaml >=5.3.1,<7.0.0
|
|
passlib[bcrypt] >=1.7.2,<2.0.0
|
|
|
|
# types
|
|
types-ujson ==5.7.0.1
|
|
types-orjson ==3.6.2
|