Skip to content

Commit 3423b18

Browse files
ilevkivskyiIvan Levkivskyi
authored andcommitted
Add docs for no_site_packages config option (#8932)
1 parent 387be66 commit 3423b18

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/source/config_file.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,10 +230,17 @@ section of the command line docs.
230230

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

233+
``no_site_packages`` (bool, default False)
234+
Disables using type information in installed packages (see :pep:`561`).
235+
This will also disable searching for a usable Python executable. This acts
236+
the same as :option:`--no-site-packages <mypy --no-site-packages>` command
237+
line flag.
238+
233239
``no_silence_site_packages`` (bool, default False)
234-
Enables reporting error messages generated within :pep:`561` compliant packages.
235-
Those error messages are suppressed by default, since you are usually
236-
not able to control errors in 3rd party code.
240+
Enables reporting error messages generated within installed packages (see
241+
:pep:`561` for more details on distributing type information). Those error
242+
messages are suppressed by default, since you are usually not able to
243+
control errors in 3rd party code.
237244

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

0 commit comments

Comments
 (0)