Skip to content

Fix a few trivial mistakes in documentation #10051

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 3 commits into from
Jun 11, 2021
Merged

Fix a few trivial mistakes in documentation #10051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bc83d4
Fix typo in redirect to topics/authentication
pradyunsg Jun 11, 2021
9687f45
Add an intersphinx link, to compatibility section
pradyunsg Jun 11, 2021
de88828
Fix typo in version added directive
pradyunsg Jun 11, 2021
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
2 changes: 2 additions & 0 deletions docs/html/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ If you face issues when using Python and pip installed using these mechanisms,
it is recommended to request for support from the relevant provider (eg: Linux
distro community, cloud provider support channels, etc).

(compatibility-requirements)=

## Compatibility

The current version of pip works on:
Expand Down
2 changes: 1 addition & 1 deletion docs/html/topics/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ https://0123456789abcdef@pypi.company.com/simple

### Percent-encoding special characters

```{versionaddded} 10.0
```{versionadded} 10.0
```

Certain special characters are not valid in the credential part of a URL.
Expand Down
6 changes: 3 additions & 3 deletions docs/html/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@ For more information and examples, see the :ref:`pip install` reference.
Basic Authentication Credentials
================================

This is now covered in {doc}`topics/authentication`.
This is now covered in :doc:`topics/authentication`.

netrc Support
-------------

This is now covered in {doc}`topics/authentication`.
This is now covered in :doc:`topics/authentication`.

Keyring Support
---------------

This is now covered in {doc}`topics/authentication`.
This is now covered in :doc:`topics/authentication`.

Using a Proxy Server
====================
Expand Down