Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
4bccdae
Fix a link
Oct 19, 2023
87042d6
Improve venv setup instructions
Oct 19, 2023
e136460
Rename two headings
Oct 19, 2023
324772f
Fix a few typos, etc.
Oct 19, 2023
ce0eaf6
Add a heading and point to it
Oct 19, 2023
6668828
Switch chapters
Oct 19, 2023
e992920
Remove redundant explanation and restructure
Oct 19, 2023
129e701
Add chapter "Things to be kept as-is"
Oct 19, 2023
e56d9b2
Add introduction sentence
Oct 19, 2023
ce8df22
"small written" -> "low-caps"
Oct 19, 2023
1b28737
Dedent heading by one
Oct 19, 2023
891ca8b
Be more explicit
Oct 19, 2023
9fcacee
Be more explicit
Oct 20, 2023
c6f38a0
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 20, 2023
240f526
Small improvements
Oct 20, 2023
887cdb9
Info box
Oct 20, 2023
2dfc8cd
Shorten the added section
Oct 20, 2023
3f54fb9
Add hint how to do it in VS Code
Oct 22, 2023
416aac2
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 25, 2023
8d332ac
Rename chapter and move it one down
Oct 30, 2023
86b73e0
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 30, 2023
b8f5057
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 31, 2023
b7a9dd5
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Nov 29, 2023
f36b0e9
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Dec 1, 2023
c6c4e90
Sync with #10844
Dec 27, 2023
aef9908
Merge remote-tracking branch 'upstream/master' into review-en/docs/co…
Dec 27, 2023
6aeb512
Fix weird things done by the VS Code merge conflict resolver.
Dec 27, 2023
6aba798
Replace three blank lines with one
Dec 27, 2023
f1dd3c5
✏️ Tweak lin formatk and micro-typo
tiangolo Jan 11, 2024
c7b7a21
Merge branch 'master' into review-en/docs/contributing.md
tiangolo Jan 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Switch chapters
"Typer CLI (optional)" <-> "Apps and docs at the same time"
  • Loading branch information
Nils Lindemann committed Oct 19, 2023
commit 666882824e46481fb63163c32c3b88d0d345ca76
30 changes: 15 additions & 15 deletions docs/en/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,41 +212,41 @@ That way, you can edit the documentation/source files and see the changes live.
$ mkdocs serve --dev-addr 8008
```

#### Typer CLI (optional)

The instructions here show you how to use the script at `./scripts/docs.py` with the `python` program directly.
#### Apps and docs at the same time

But you can also use <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">Typer CLI</a>, and you will get autocompletion in your terminal for the commands after installing completion.

If you install Typer CLI, you can install completion with:
If you run the examples with, e.g.:

<div class="termy">

```console
$ typer --install-completion
$ uvicorn tutorial001:app --reload

zsh completion installed in /home/user/.bashrc.
Completion will take effect once you restart the terminal.
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```

</div>

### Apps and docs at the same time
as Uvicorn by default will use the port `8000`, the documentation on port `8008` won't clash.

If you run the examples with, e.g.:
#### Typer CLI (optional)

The instructions here show you how to use the script at `./scripts/docs.py` with the `python` program directly.

But you can also use <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">Typer CLI</a>, and you will get autocompletion in your terminal for the commands after installing completion.

If you install Typer CLI, you can install completion with:

<div class="termy">

```console
$ uvicorn tutorial001:app --reload
$ typer --install-completion

<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
zsh completion installed in /home/user/.bashrc.
Completion will take effect once you restart the terminal.
```

</div>

as Uvicorn by default will use the port `8000`, the documentation on port `8008` won't clash.

### Translations

Help with translations is VERY MUCH appreciated! And it can't be done without the help from the community. 🌎 πŸš€
Expand Down