Skip to content

gh-82419: Improve site docs to clarify user site-packages disabling #125083

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 3 commits into
base: main
Choose a base branch
from
Open

gh-82419: Improve site docs to clarify user site-packages disabling #125083

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afd431d
gh-82419 Refactor site.rst to clarify user site-packages disabling
pppppkun Oct 8, 2024
99a15eb
gh-82419 Revised the site docs about user site-packages disabling
pppppkun Oct 9, 2024
ef8b8cf
gh-82419 Revise the format of docs
pppppkun Oct 9, 2024
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
6 changes: 6 additions & 0 deletions Doc/library/site.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,12 @@ Module contents
reasons (mismatch between user or group id and effective id) or by an
administrator.

Note that :func:`getusersitepackages` and :func:`getuserbase`
don't take this variable into account. The check for :data:`ENABLE_USER_SITE` and
modification of ``sys.path`` occur later. To disable user site-packages,
users are encouraged to create :mod:`sitecustomize` or :mod:`usercustomize`,
rather than try to edit :file:`site.py`.


.. data:: USER_SITE

Expand Down
Loading