📝 Add misc dependency installs to tutorial docs#2126
Merged
tiangolo merged 5 commits intoAug 18, 2022
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2126 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 532 532
Lines 13684 13684
=========================================
Hits 13684 13684 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Contributor
|
📝 Docs preview for commit becbb8b618cba8a5b731e7bf9277973ebce849d0 at: https://5f78e963b71464eabdcbc896--fastapi.netlify.app |
Given its relative centrality to this topic of the tutorial, took style cues from other tutorial docs with similar circumstances (e.g., `testing.md`, `static-files.md`, etc.) and added as a standalone installation section.
becbb8b to
8247ff6
Compare
Contributor
|
📝 Docs preview for commit 8247ff6 at: https://5f78f79083304e04f9f8944d--fastapi.netlify.app |
Kludex
approved these changes
Oct 3, 2020
ycd
approved these changes
Oct 4, 2020
|
I think you can add one more, to fix #2134 |
Given its relative centrality to this topic of the tutorial, took style cues from other tutorial docs with similar circumstances (e.g., `testing.md`, `static-files.md`, etc.) and added as a standalone installation section. Closes fastapi#2134
ycd
approved these changes
Oct 5, 2020
Contributor
|
📝 Docs preview for commit b589bde at: https://5f7b702b676f552e9ed3bcf5--fastapi.netlify.app |
AdrianDeAnda
approved these changes
Oct 8, 2020
Member
|
Thanks for the contribution @TeoZosa! 🎉 |
Contributor
|
📝 Docs preview for commit 307c183 at: https://62fe9cd86ec0de14f818275e--fastapi.netlify.app |
JeanArhancet
pushed a commit
to JeanArhancet/fastapi
that referenced
this pull request
Aug 20, 2022
Co-authored-by: Sebastián Ramírez <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Just some small (potential) improvements to the tutorial, adding required dependency installations that are otherwise not mentioned in their corresponding tutorial sections.
Reasoning:
Although:
SQLAlchemy) in the documentation home page (docs/index.md) under the section "Optional Dependencies"docs/tutorial/index.md) recommends installing FastAPI with all the optional dependencies and features (i.e.,pip install fastapi[all])These additions may still be helpful for beginners and seem to be in keeping with the style of the documentation as a whole (i.e., standalone sections).