ty/mkdocs.yml at main · astral-sh/ty · GitHub

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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
site_name: ty
theme:
  name: material
  logo: assets/logo-letter.svg
  favicon: assets/favicon.ico
  features:
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.sections
    - navigation.indexes
    - navigation.tracking
    - content.code.annotate
    - toc.follow
    - navigation.footer
    - navigation.top
    - content.code.copy
    - content.tabs.link
  palette:
    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: astral-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: astral-dark
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  custom_dir: docs/.overrides
repo_url: https://github.com/astral-sh/ty
repo_name: ty
site_author: astral-sh
site_url: https://docs.astral.sh/ty/
site_dir: site/ty
site_description: ty is an extremely fast Python type checker.
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.snippets:
  - pymdownx.magiclink:
  - attr_list:
  - toc:
      anchorlink: true
      anchorlink_class: "toclink"
  - md_in_html:
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
  - markdown.extensions.attr_list:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true
plugins:
  - search
  - git-revision-date-localized:
      timezone: UTC # It can only be in UTC unless the ISO time can include timezone.
  - llmstxt:
      markdown_description: |
        ty is an extremely fast Python type checker and a language server written in Rust.
        It can type check large Python codebases in seconds, providing fast feedback
        during development.

        ty includes both a CLI (`ty check`) and a language server (`ty server`) for editor integration.

        When fetching documentation, use explicit `index.md` paths for directories, e.g.,
        `https://docs.astral.sh/ty/features/index.md`. This returns clean markdown instead
        of rendered HTML with JS/CSS.
      sections:
        Guides:
          - installation.md
          - type-checking.md
          - editors.md
        Concepts:
          - configuration.md
          - modules.md
          - python-version.md
          - exclusions.md
          - rules.md
          - suppression.md
        Features:
          - features/type-system.md
          - features/diagnostics.md
          - features/language-server.md
        Reference:
          - reference/configuration.md
          - reference/typing-faq.md
          - reference/rules.md
          - reference/cli.md
          - reference/exit-codes.md
          - reference/environment.md
          - reference/editor-settings.md
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - js/extra.js
extra:
  analytics:
    provider: fathom
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/astral-sh/ty
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/astral-sh
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ty/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/astral_sh
nav:
  - Introduction: index.md
  - Guides:
      - Installation: installation.md
      - Type checking: type-checking.md
      - Editor integration: editors.md
  - Concepts:
      - Configuration: configuration.md
      - Module discovery: modules.md
      - Python version: python-version.md
      - File exclusions: exclusions.md
      - Rules: rules.md
      - Suppression: suppression.md
  - Features:
      - Type system: features/type-system.md
      - Diagnostics: features/diagnostics.md
      - Language server: features/language-server.md
  - Reference:
      - Configuration: reference/configuration.md
      - Typing FAQ: reference/typing-faq.md
      - Rules: reference/rules.md
      - CLI: reference/cli.md
      - Exit codes: reference/exit-codes.md
      - Environment variables: reference/environment.md
      - Editor settings: reference/editor-settings.md
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn