Commit Graph

102 Commits

Author SHA1 Message Date
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 5eae3c9235
Merge pull request #9040 from ei8fdb/include-backtracking-in-user-guide 2020-11-15 00:28:03 +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
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 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
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
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
Pradyun Gedam fb03b6aede
Switch to sphinx-inline-tabs for tabs 2020-10-18 22:42:24 +05:30
David Poggi e48234e669
Fix docs for trusted-host in config file 2020-10-08 11:43:08 -04:00
Sumana Harihareswara 3b44d70b5e docs: Add how to default to new resolver
Fixes #8661.
2020-09-30 07:12:10 -04:00
Pradyun Gedam 75befb5a44
Merge pull request #8589 from shireenrao/upd-pip-docs 2020-09-24 21:43:38 +05:30
Pradyun Gedam 89dad17b87
Update linter: pygrep-hooks 2020-09-23 19:52:20 +05:30
Srinivas Nyayapati a2e2f5d052 update all tabs with command output be console code-blocks 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 28a00633d8 Remove platform prompt when not output is displayed 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati bcd0450158 WIP - update getting-started and pip ref docs 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 55c06d181b WIP - use code-block within group-tab for consistent look 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati f1abd651e3 WIP change user guide + make consistent changes across 2020-09-13 20:59:28 -04:00
Xavier Fernandez 7fdf1634e0
Merge pull request #8795 from McSinyx/user-guide-fmt
Reformat a few spots in user guide
2020-09-13 15:08:09 +02:00
Srinivas Nyayapati 8e622390d0 mention using only ASCII for password 2020-09-04 16:42:26 -04:00
Srinivas Nyayapati 1b0517e68b Add documentation for netrc support 2020-09-04 16:42:26 -04:00
Xavier Fernandez 83f1640827
Merge pull request #8578 from McSinyx/parse-count
Allow verbose/quiet level to be specified via config file and env var
2020-09-03 18:34:53 +02:00
Nguyễn Gia Phong 984fa3c664 Make version specifier explanation easier to read in reST 2020-08-24 15:53:29 +07:00
Nguyễn Gia Phong f060669e05 Fix indentation of lists and literal blocks 2020-08-24 15:42:31 +07:00
wim glenn 1f0ace9a2e
restore a broken slug anchor in user guide 2020-08-18 20:57:08 -05:00
Chris Hunt 2e4d748897
Merge pull request #8636 from EpicWink/doc/keyring
Document keyring support for index basic-auth
2020-08-08 09:05:32 -04:00
Pradyun Gedam d8ba146e65
Merge pull request #8672 from edmorley/fix-userguide-typos 2020-08-04 08:39:32 +05:30
Pradyun Gedam 57ee51c2b1
Un-rewrap lines 2020-08-04 06:55:17 +05:30
Sumana Harihareswara 20663fc993 Docs: Add details on old resolver deprecation and removal
Relevant to #8371, #6536, #8076.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-08-03 10:45:25 -04:00
Pradyun Gedam 22aec424d9
Rewrap lines
Co-authored-by: Nguyễn Gia Phong <mcsinyx@disroot.org>
2020-08-02 07:46:54 +05:30
Ed Morley f31898e18c Fix typos in the docs about conflicting dependencies
Previously:
- the example wildcard version string was being rendered with a stray
  space (`== 3.1. *` instead of `== 3.1.*`) due to the markup being
  split over two lines
- the "Dependency Hell" Wikipedia URL 404ed due to the trailing `>`
2020-07-31 13:17:36 +01:00
Sumana Harihareswara 27b4980c6c Update documentation to reflect updated resolver feature flag
Followup to #8371, #8530, #8513.
2020-07-30 14:02:14 -04:00
Sumana Harihareswara 66d39f942c Clarify on conflicts and multiplicity 2020-07-28 11:25:05 -04:00
Sumana Harihareswara 263f85b0ad formatting fix 2020-07-28 10:21:52 -04:00
Sumana Harihareswara ec736200f4 formatting 2020-07-28 10:16:58 -04:00