File: mkdocs.yml

package info (click to toggle)
typer 0.19.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,688 kB
  • sloc: python: 16,702; javascript: 280; sh: 28; makefile: 27
file content (123 lines) | stat: -rw-r--r-- 3,907 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
site_name: Typer
site_description: Typer, build great CLIs. Easy to code. Based on Python type hints.
site_url: https://typer.tiangolo.com/

theme:
  name: 'readthedocs'
  palette:
      primary: 'black'
      accent: 'teal'
  icon:
      repo: fontawesome/brands/github-alt
  logo: 'img/icon-white.svg'
  favicon: 'img/favicon.png'

repo_name: tiangolo/typer
repo_url: https://github.com/tiangolo/typer
edit_uri: ""

nav:
  - Typer: index.md
  - features.md
  - Tutorial - User Guide:
      - tutorial/index.md
      - environment-variables.md
      - virtual-environments.md
      - tutorial/install.md
      - tutorial/first-steps.md
      - tutorial/printing.md
      - tutorial/terminating.md
      - CLI Arguments:
          - tutorial/arguments/index.md
          - tutorial/arguments/optional.md
          - tutorial/arguments/default.md
          - tutorial/arguments/help.md
          - tutorial/arguments/envvar.md
          - tutorial/arguments/other-uses.md
      - CLI Options:
          - tutorial/options/index.md
          - tutorial/options/help.md
          - tutorial/options/required.md
          - tutorial/options/prompt.md
          - tutorial/options/password.md
          - tutorial/options/name.md
          - tutorial/options/callback-and-context.md
          - tutorial/options/version.md
      - Commands:
          - tutorial/commands/index.md
          - tutorial/commands/arguments.md
          - tutorial/commands/options.md
          - tutorial/commands/help.md
          - tutorial/commands/name.md
          - tutorial/commands/callback.md
          - tutorial/commands/one-or-multiple.md
          - tutorial/commands/context.md
      - tutorial/options-autocompletion.md
      - CLI Parameter Types:
          - tutorial/parameter-types/index.md
          - tutorial/parameter-types/number.md
          - tutorial/parameter-types/bool.md
          - tutorial/parameter-types/uuid.md
          - tutorial/parameter-types/datetime.md
          - tutorial/parameter-types/enum.md
          - tutorial/parameter-types/path.md
          - tutorial/parameter-types/file.md
          - tutorial/parameter-types/custom-types.md
      - SubCommands - Command Groups:
          - tutorial/subcommands/index.md
          - tutorial/subcommands/add-typer.md
          - tutorial/subcommands/single-file.md
          - tutorial/subcommands/nested-subcommands.md
          - tutorial/subcommands/callback-override.md
          - tutorial/subcommands/name-and-help.md
      - Multiple Values:
          - tutorial/multiple-values/index.md
          - tutorial/multiple-values/multiple-options.md
          - tutorial/multiple-values/options-with-multiple-values.md
          - tutorial/multiple-values/arguments-with-multiple-values.md
      - tutorial/prompt.md
      - tutorial/progressbar.md
      - tutorial/app-dir.md
      - tutorial/launch.md
      - tutorial/testing.md
      - tutorial/using-click.md
      - tutorial/package.md
      - tutorial/exceptions.md
      - tutorial/one-file-per-command.md
      - tutorial/typer-command.md
  - Resources:
    - resources/index.md
    - help-typer.md
    - contributing.md
    - management-tasks.md
  - About:
    - about/index.md
    - alternatives.md
    - management.md
  - release-notes.md

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/fastapi/typer
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/tiangolo
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/tiangolo
    - icon: fontawesome/brands/dev
      link: https://dev.to/tiangolo
    - icon: fontawesome/brands/medium
      link: https://medium.com/@tiangolo
    - icon: fontawesome/solid/globe
      link: https://tiangolo.com

extra_css:
  - css/termynal.css
  - css/custom.css

extra_javascript:
  - js/termynal.js
  - js/custom.js

hooks:
  - scripts/mkdocs_hooks.py