mirrors/ty
1
0
Fork 0
mirror of https://github.com/astral-sh/ty.git synced 2025-07-07 19:45:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update documentation links to point to https://docs.astral.sh/ty/

Browse source
This commit is contained in:
David Peter 2025-07-02 16:24:11 +02:00 • committed by Zanie Blue
parent c70ae8c84a
commit f867272b3a
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -16,11 +16,11 @@ ty's command-line help text, and part of `docs/reference/`, are auto-generated f
repository, using generation scripts that live in repository, using generation scripts that live in
[`crates/ruff_dev/src/`](https://github.com/astral-sh/ruff/blob/main/crates/ruff_dev/src/): [`crates/ruff_dev/src/`](https://github.com/astral-sh/ruff/blob/main/crates/ruff_dev/src/):
- [Configuration options](docs/reference/configuration.md), from - [Configuration options](https://docs.astral.sh/ty/reference/configuration/), from
[ruff/crates/ty_project/src/metadata/options.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty_project/src/metadata/options.rs) [ruff/crates/ty_project/src/metadata/options.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty_project/src/metadata/options.rs)
- [Rules](docs/reference/rules.md), from - [Rules](https://docs.astral.sh/ty/reference/rules/), from
[ruff/crates/ty_python_semantic/src/](https://github.com/astral-sh/ruff/blob/main/crates/ty_python_semantic/src/) [ruff/crates/ty_python_semantic/src/](https://github.com/astral-sh/ruff/blob/main/crates/ty_python_semantic/src/)
- [Command-line interface reference](docs/reference/cli.md), from - [Command-line interface reference](https://docs.astral.sh/ty/reference/cli/), from
[ruff/crates/ty/src/args.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty/src/args.rs) [ruff/crates/ty/src/args.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty/src/args.rs)
The Ruff repository is included as a submodule inside this repository to allow ty's release tags to reflect The Ruff repository is included as a submodule inside this repository to allow ty's release tags to reflect

8
README.md
View file

@ -21,10 +21,10 @@ Try out the [online playground](https://play.ty.dev), or run ty with
uvx ty uvx ty
``` ```
For other ways to install ty, see the [installation](./docs/README.md#installation) documentation. For other ways to install ty, see the [installation](https://docs.astral.sh/ty/installation/) documentation.
If you do not provide a subcommand, ty will list available commands — for detailed information about If you do not provide a subcommand, ty will list available commands — for detailed information about
command-line options, see the [CLI reference](./docs/reference/cli.md). command-line options, see the [CLI reference](https://docs.astral.sh/ty/reference/cli/).
Use the `check` command to run the type checker: Use the `check` command to run the type checker:
@ -45,12 +45,12 @@ uvx ty check example.py
When type checking, ty will find installed packages in the active virtual environment (via When type checking, ty will find installed packages in the active virtual environment (via
`VIRTUAL_ENV`) or discover a virtual environment named `.venv` in the project root or working `VIRTUAL_ENV`) or discover a virtual environment named `.venv` in the project root or working
directory. It will not find packages in non-virtual environments without specifying the target path directory. It will not find packages in non-virtual environments without specifying the target path
with `--python`. See the [module discovery](./docs/README.md#module-discovery) documentation for with `--python`. See the [module discovery](https://docs.astral.sh/ty/modules/) documentation for
details. details.
## Learning more ## Learning more
To learn more about using ty, see the [documentation](./docs/README.md). To learn more about using ty, see the [documentation](https://docs.astral.sh/ty/).
## Getting involved ## Getting involved