Skip to content

Add documentation for PYTHONPATH config #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −0
Open

Add documentation for PYTHONPATH config #1072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,11 @@ The Python environment may be explicitly configured using the
[`--python`](./reference/cli.md#ty-check--python) flag.

When setting the environment explicitly, non-virtual environments can be provided.

## PYTHONPATH

Python supports setting the `PYTHONPATH` environment variable to control module lookup
per-environment.

If ty should read this environment variable for lookup paths
[`environment.read-python-path`](./reference/configuration.md#read-python-path) should be set to true.
16 changes: 16 additions & 0 deletions docs/reference/configuration.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.