Pradyun Gedam
c383ec3b41
Merge pull request #9172 from webknjaz/docs/unreleased-change-fragments-preview
...
Add a preview for the "next release" change notes
2020-12-26 10:50:10 +00:00
Pradyun Gedam
86afa89043
Merge pull request #9361 from jdufresne/f-strings
...
Use f-strings for simple string formatting
2020-12-26 10:24:18 +00:00
Pradyun Gedam
7407bc1e8a
Merge pull request #9353 from ichard26/fix_broken_mailto_link
...
Fix broken email link in docs feedback banners
2020-12-26 10:21:59 +00:00
Jon Dufresne
cdcf74fb8e
Use f-strings for simple string formatting
...
Use pyupgrade to convert simple string formatting to use f-string
syntax. pyupgrade is intentionally timid and will not create an f-string
if it would make the expression longer or if the substitution parameters
are anything but simple names or dotted names.
2020-12-25 16:21:20 -08:00
Jon Dufresne
ba40f58ecc
Remove encoding cookie from Python source files
...
Unnecessary since dropping Python 2. Python now decodes files as utf-8
by default.
2020-12-25 07:26:07 -08:00
Jon Dufresne
2e38024991
Drop u prefix from str literals
...
Unnecessary since dropping Python 2 support.
This makes one test case from test_str_to_display a duplicate and so has
been removed.
2020-12-25 07:26:06 -08:00
Richard Si
a61586cdcf
Fix broken email link in docs feedback banners
...
'docs-feedback+ux/pip.pypa.io@pypa.io' isn't a valid email address, so
I replaced it with the right email address according to this GitHub
comment:
https://github.com/pypa/pip/issues/8783#issuecomment-685823974
2020-12-24 18:07:15 -05:00
Hugo van Kemenade
817ee23051
Remove redundant Python 2.7 code
2020-12-22 09:06:26 +02:00
Pradyun Gedam
4f4cf38c46
Update passage on Python 2 support
2020-12-20 12:03:00 +00:00
Pradyun Gedam
0befae128a
Drop CI info about Python 2.7/3.5
2020-12-19 19:55:04 +00:00
Sumana Harihareswara
acc0cc9fe3
docs: Fix typo
...
Co-authored-by: Xavier Fernandez <xav.fernandez@gmail.com>
2020-12-14 06:46:14 -05:00
Sumana Harihareswara
df7a97f3bc
docs: Fix small style issues.
...
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-12-13 17:37:28 -05:00
Sumana Harihareswara
c7591bf973
docs: Clarify that old resolver is default with Python 2
...
Partially addresses #9194 .
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-12-13 17:25:59 -05:00
Sviatoslav Sydorenko
0ddfe08828
Add a preview for the "next release" change notes
...
This change integrates `sphinxcontrib-towncrier` into the docs build.
It uses Towncrier and its configs to render a draft changelog as RST
and injects that into the `news.rst` document right above the older
changelog entries using `towncrier-draft-entries` directive.
Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
2020-12-10 15:36:51 +01:00
Pradyun Gedam
a498c13158
Merge pull request #9174 from pradyunsg/tweaks-to-migration-guide
...
Expand on troubleshooting steps in resolver migration guide
2020-11-29 21:17:35 +00:00
Pradyun Gedam
9c8dfdd313
Expand on troubleshooting steps in resolver migration guide
...
Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>
2020-11-29 21:10:01 +00:00
Pradyun Gedam
0579cacd42
Describe changelog quirk around beta release
...
This helps guide users who are reading changelogs better understand what
changes are a part of a "main" release.
2020-11-29 20:20:44 +00:00
Sviatoslav Sydorenko
5b71640447
Fix handling orphan documents in the feedback ext
...
Before this change, the cut-off step was present but the new string
wasn't assigned back and this resulted in `:orphan:` not only re-
injected at the beginning of the document but also left over after
the admonition.
2020-11-28 23:52:52 +01:00
Pradyun Gedam
5eae3c9235
Merge pull request #9040 from ei8fdb/include-backtracking-in-user-guide
2020-11-15 00:28:03 +05:30
Pradyun Gedam
23324a664f
Merge pull request #9131 from uranusjr/install-method-order
2020-11-14 04:06:17 +05:30
Tzu-ping Chung
657d91f672
Reorder and revise installation docs
...
An additional section is added to instruct the user to self-check
whether pip is installed before proceeding.
The Linux package manager section is moved to the front to encourage
users to try that first before learning about get-pip.py, which tends to
provide seemingly working but subtly broken results there. A paragraph
is added to the section to instruct users to report issues to package
managers instead.
A new section on enturepip is added as an alternative to get-pip.py,
which is almost guarenteed to be available at this point.
2020-11-14 05:37:03 +08:00
Pradyun Gedam
321163fb98
Fix misplaced blockquotes
...
Signed-off-by: Pradyun Gedam <pradyunsg@users.noreply.github.com>
2020-11-12 07:29:19 +05:30
Pradyun Gedam
6962284236
Remove inline table of contents
...
Furo provides a fully-fleshed-out right sidebar that provides an in-page
table of contents, that's scrollable and does not interrupt content.
2020-11-12 07:29:19 +05:30
Pradyun Gedam
f3ee03d6d0
Drop custom styling for admonitions
2020-11-12 07:29:19 +05:30
Pradyun Gedam
19717d1701
Switch documentation theme to Furo
2020-11-12 07:29:19 +05:30
Pradyun Gedam
5bfc0259f9
Clarify which version of pip we're seeing
2020-11-12 07:29:18 +05:30
Bernard
90925a7157
Fixed linting failures. 🤞
2020-11-11 12:59:37 +01:00
Bernard
8383249442
Incorporating commit: e6acca646abcaaac7515da9b964d5b5291264142
2020-11-11 11:20:29 +01:00
Bernard
00f3d57131
Final heading edit.
2020-10-30 12:35:52 +01:00
Bernard
29d1f4506e
Adding link to Constraints Files
2020-10-30 12:31:01 +01:00
Sumana Harihareswara
3f4e15aef0
docs: Emphasize that pip may break existing packages
...
Related to #7744 .
2020-10-29 13:51:29 -04:00
Sumana Harihareswara
fbcdeca91a
Clarify constraints overhaul in user guide
...
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
395e1ae8e8
Add detail to docs on constraints changes with new resolver
...
Related to #8307 , #8115 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
27b100e8d1
Explain resolver changes affecting constraints files
...
Related to #8792 , #8076 , #9020 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
5393032025
Improve docs on resolver, constraints, and hash-checking
...
Related to #9020 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
b7c3503a34
Add note about install/upgrade behavior to docs
...
Towards #8115 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
7657c44409
docs: Clarify links for resolver work and studies
...
Co-Authored-By: Bernard Tyers <bernard+work@ei8fdb.org>
2020-10-28 23:29:09 -04:00
Sumana Harihareswara
4ce9565aa1
Update docs about Python 2 and resolver
...
Per #9019 .
2020-10-28 23:22:17 -04:00
Sumana Harihareswara
f4e96e95c9
Add redirect for heading in user guide
2020-10-28 23:22:17 -04:00
Sumana Harihareswara
3a20399d93
Update user guide to change resolver default
...
In pip 20.3, the new resolver will be the default.
Therefore, this commit updates user docs to change
instructions for testing, migration, etc.
Towards #8937 .
2020-10-28 23:22:17 -04:00
Xavier Fernandez
1cd89f824a
Fix trivial news file generation on windows
2020-10-28 23:55:13 +01:00
Bernard Tyers
0cf0092981
Apply suggestions from code review
...
Co-authored-by: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com>
Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>
2020-10-28 14:30:04 +01:00
Bernard
e3675c5a93
Committing edits.
2020-10-28 12:56:45 +01:00
Daniel Katz
cea9f32dae
Support multiple `abi` and `platform` values for `pip download`.
2020-10-27 19:00:22 -04:00
Xavier Fernandez
c15f8672ec
Merge pull request #8972 from drpoggi/patch-1
...
Fix docs for trusted-host in config file
2020-10-26 23:58:47 +01:00
Bernard
95e78ab284
Editing to make shorten content (reduce/remove duplication), add anchor.
2020-10-26 13:23:07 +01:00
Bernard
ecda23819b
Updating file with PR review edits.
2020-10-26 10:14:34 +01:00
Bernard
b49a213b56
fix syntax
2020-10-23 15:16:39 +02:00
Bernard
cf89b0b6c2
updating user guide with backtracking information
2020-10-23 15:14:19 +02:00
Bernard
b8cd76339d
WIP
...
updating user guide documentation with explanation and solutions to pip
backtracking
2020-10-21 17:50:04 +02:00