fastapi
✨ Add reference (code API) docs with PEP 727, add subclass with custom docstrings for `BackgroundTasks`, refactor docs structure
#10392
Merged
Merged
➕ Add mkdocstrings and griffe-typingdoc to dependencies
7c8c30cc
🔧 Add mkdocstrings configs to MkDocs
2efbf3ba
📝 Add first WIP reference page
8bf900ce
⬆️ Upgrade typing-extensions to the minimum version including Doc()
77ae8a45
📝 Add docs to FastAPI parameters
df4c5011
tiangolo
commented
on 2023-10-13
📝 Add docstrings for OpenAPI docs utils
92573b3c
📝 Add docstrings for security utils
0cae8305
📝 Add docstrings for UploadFile
98300554
📝 Update docstrings in FastAPI class
d5518fb4
📝 Add docstrings for path operation methods
da98d291
📝 Add docstring for jsonable_encoder
3e2a0496
📝 Add docstrings for exceptions
8a672afd
📝 Add docstsrings for parameter functions
93418711
📝 Add docstrings for responses
f77ee859
📝 Add docstrings for APIRouter
a03b4c38
♻️ Sub-class BackgroundTasks to document it with docstrings
e06f01fb
📝 Update usage of background tasks in dependencies
222f6ac1
✅ Update tests with new deprecation warnings
496cf7df
📝 Add new reference docs
6882e9c9
🔧 Update MkDocs with new reference docs
8d224edc
✅ Update pytest fixture, deprecation is raised only once
f55ce131
🎨 Update format for types in exceptions.py
864c8ebc
♻️ Update annotations in BackgroundTask, `Annotated` can't take Param…
c9a2fb35
✏️ Fix typos caught by @pawamoy
5ca7caa8
🔧 Update and fix MkDocstrings configs from @pawamoy tips
3b118113
📝 Update reference docs
2867297f
✏️ Fix typos found by @pawamoy
136aef86
➕ Add HTTPX as a dependency for docs, for the TestClient
5fc219be
🔧 Update MkDocs config, rename websockets reference
79718d85
Merge branch 'master' into ref-docs
d7b1e1b4
🔇 Add type-ignores for Doc as the stubs haven't been released for mypy
b8e9e02a
🔥 Remove duplicated deprecated notice
2dc2f803
🔇 Remove typing error for unreleased stub in openapi/docs.py
912a3ec1
✅ Add tests for UploadFile for coverage
ed277ea5
⬆️ Upgrade griffe-typingdoc==0.2.2
5b02bc07
📝 Refactor docs structure
b7e59f93
🔨 Update README generation with new index frontmatter and style
a6b92eac
🔨 Update generation of languages, remove from top menu, keep in lang …
0003519f
Merge branch 'master' into ref-docs
ba112c39
📝 Add OpenAPI Pydantic models
9176a993
🔨 Update docs script to not translate Reference and Release Notes
eba928cd
🔧 Add reference for OpenAPI models
9a8e04b6
🔧 Update MkDocs config for mkdocstrings insiders
61defbde
👷 Install mkdocstring insiders in CI for docs
f1ec8acd
🐛 Fix MkDocstrings insiders install URL
e2c36729
➕ Move dependencies shared by docs and tests to its own requirements …
5b999484
👷 Update cache keys for test and docs dependencies
c34b8c9b
tiangolo
changed the title
📝 Remove no longer needed __init__ placeholder docstrings
de4c24e4
📝 Move docstring for APIRouter to the class level (not __init__ level)
77cb0c7d
🔥 Remove no longer needed dummy placeholder __init__ docstring
ac82b9ed
tiangolo
changed the title
Login to write a write a comment.
Login via GitHub