Skip to content

Add docs for no_site_packages config option #8932

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

Merged
merged 4 commits into from
Jun 2, 2020
Merged

Add docs for no_site_packages config option #8932

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3183dbb
Add docs for no_site_packages config option
Jun 2, 2020
12f1eb3
Address CR
Jun 2, 2020
1db78a4
Fix docs build
Jun 2, 2020
635cf10
Fix docs build
Jun 2, 2020
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
13 changes: 10 additions & 3 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,10 +230,17 @@ section of the command line docs.

This option may only be set in the global section (``[mypy]``).

``no_site_packages`` (bool, default False)
Disables using type information in installed packages (see :pep:`561`).
This will also disable searching for a usable Python executable. This acts
the same as :option:`--no-site-packages <mypy --no-site-packages>` command
line flag.

``no_silence_site_packages`` (bool, default False)
Enables reporting error messages generated within :pep:`561` compliant packages.
Those error messages are suppressed by default, since you are usually
not able to control errors in 3rd party code.
Enables reporting error messages generated within installed packages (see
:pep:`561` for more details on distributing type information). Those error
messages are suppressed by default, since you are usually not able to
control errors in 3rd party code.

This option may only be set in the global section (``[mypy]``).

Expand Down