Skip to content

docs: fix doubled backslashes in Windows pip config path #1149

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
henryiii merged 2 commits into from
Sep 4, 2026
Merged

docs: fix doubled backslashes in Windows pip config path #1149

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd65284
docs: fix doubled backslashes in Windows pip config path
aroh3006 Aug 12, 2026
5ebd23e
docs: shorten changelog entry for #1149
aroh3006 Sep 4, 2026
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
3 changes: 3 additions & 0 deletions docs/changelog/1149.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Write the Windows pip configuration path as ``%APPDATA%\pip\pip.ini`` in the environment variables reference and the
corporate environments how-to; the backslashes were doubled inside an inline literal, where reStructuredText does not
treat them as escapes, so the rendered docs showed an invalid path - by :user:`aroh3006`

@henryiii henryiii Aug 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is way too much for a minor docs mixup. :)

@aroh3006 aroh3006 Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense. I'll keep the explanations shorter.

@henryiii henryiii Sep 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

2 changes: 1 addition & 1 deletion docs/how-to/corporate-environments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ On Linux/macOS (``~/.config/pip/pip.conf``):
trusted-host = pypi.company.com
cert = /path/to/company-ca-bundle.crt

On Windows (``%APPDATA%\\pip\\pip.ini``):
On Windows (``%APPDATA%\pip\pip.ini``):

.. code-block:: ini

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/environment-variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ This is convenient if you always use the same settings.

**Linux/macOS**: ``~/.config/pip/pip.conf``

**Windows**: ``%APPDATA%\\pip\\pip.ini``
**Windows**: ``%APPDATA%\pip\pip.ini``

Example configuration:

Expand Down
Loading