McSinyx/pip
1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
Code Issues Releases Activity
12951 commits 3 branches 142 tags 93 MiB
Commit graph

1367 commits

Author SHA1 Message Date
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
Nguyễn Gia Phong 279e735969 Update docs for less common news extension 
Namely trivial, vendor and process.  These were missed
during the trasition to *.rst news fragment.
 2020-10-19 22:37:10 +07: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
Pradyun Gedam a0f2f2cd5f
Merge pull request #8942 from brainwane/docs-8661 
docs: Add how to default to new resolver
 2020-10-06 18:56:56 +05:30
Pradyun Gedam 603b2fa4ca
Rework the NEWS entries section 2020-10-03 16:48:56 +05:30
Sumana Harihareswara 3b44d70b5e docs: Add how to default to new resolver 
Fixes #8661.
 2020-09-30 07:12:10 -04:00
Pradyun Gedam fe2075b686
Merge pull request #8848 from webknjaz/features/8783--sphinx-ext-admonitions 2020-09-30 11:00:43 +05:30
Sumana Harihareswara 6138184e2c Update docs index page about resolver and UX work 2020-09-28 15:23:55 -04:00
Hugo van Kemenade d4686b5793 Document Python support policy 2020-09-27 21:11:35 +03:00
Sviatoslav Sydorenko 13962cd6ad
🎨 Colorize the "important" admonition blocks 2020-09-25 23:25:36 +02:00
Sviatoslav Sydorenko 3301284810
📝 Add initial sphinx ext for per-doc feedbacks 
Resolves #8783
 2020-09-25 23:25:35 +02:00
Pradyun Gedam 75befb5a44
Merge pull request #8589 from shireenrao/upd-pip-docs 2020-09-24 21:43:38 +05:30
Pradyun Gedam 955daa940a
Merge pull request #7859 from pradyunsg/docs/deep-dive-cli 
Architecture Documentation: CLI deep dive
 2020-09-24 02:00:24 +05:30
Pradyun Gedam 89dad17b87
Update linter: pygrep-hooks 2020-09-23 19:52:20 +05:30
Pradyun Gedam e408f7077f
Merge pull request #8873 from hugovk/docs-3-months-deprecation 2020-09-21 02:26:17 +05:30
Hugo van Kemenade 294995bc47
Fix typo 2020-09-14 23:00:48 +03:00
shireenrao 8f3151324f fix inconsistent indentation of tab blocks 2020-09-13 20:59:29 -04:00
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 c36bd748f3 fix tox.ini and conf.py to use sphinx_tabs_nowarn 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 7673712d3e Add tabs to get-pip.py install page 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 4a6276bfc9 Add tabs to ref docs 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 423ccfd4f1 WIP upd directive to use cmd prefix + upd ref docs 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati da3b7e0578 WIP - update pip-command-usage to take optional arguments and update pip install docs 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
Srinivas Nyayapati ad8cc27b8c update quickstart.rst to use tabs 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 28f3f2cd2c ignore sphinx-tab extension for man builds 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 119d8666b4 implement sphinx-tabs on installing page of docs 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 2329d79689 use shell instead of mentioning specific platform in installing doc 2020-09-13 20:47:16 -04:00
Srinivas Nyayapati 12fe2872cc first set of changes to use python -m to run pip in the docs 2020-09-13 20:47:16 -04:00
Pradyun Gedam a13f2014f9
Merge pull request #8780 from eamanu/fix-8009 2020-09-14 00:49:33 +05:30
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
Hugo van Kemenade b6fb8b80e2 Reflow paragraph 2020-09-13 10:23:22 +03:00
Hugo van Kemenade 8385cb5250 Document fast-track deprecation policy 2020-09-13 10:23:22 +03:00
Emmanuel Arias 65bddac52f
Update Caching documentation 
Any headers from serve are ignored. So, this PR remove
the paragraph that mention that. See #8009 and #5670

Close #8009
 2020-09-07 10:50:03 -03: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
Nicole Harris d570e50402 Update docs based on feedback from UX team 2020-09-01 18:43:11 +01:00
Nicole Harris 46bdaa1ece Add ux docs to pip documentation 2020-08-26 10:42:22 +01:00
Pradyun Gedam c50307ebc4
Merge pull request #8781 from wimglenn/patch-1 2020-08-25 19:06:29 +05:30
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
Srinivas Nyayapati 4e34f6530a add theme config to set background color and text color for code-blocks 2020-08-20 12:24:58 -04:00
Srinivas Nyayapati ce85775155 Bump Sphinx to v3.1.2 and fix rst issues 2020-08-20 07:47:36 -04: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 595aa7b294
Merge pull request #8651 from pradyunsg/update-coc-reference 2020-08-07 09:58:52 +05:30
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
Pradyun Gedam c7af6a420c
Update Code of Conduct references 2020-07-29 23:16:12 +05:30
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
Sumana Harihareswara 1e5e544b5c Ref links and followup tips 2020-07-28 10:01:03 -04:00
Sumana Harihareswara 223e379456 WIP formatting 2020-07-28 09:50:46 -04:00
Sumana Harihareswara 6bfbce0adc WIP adding links to issues 
Addresses #8210 , #8253
 2020-07-28 09:47:07 -04:00
Sumana Harihareswara a910ef6d37 WIP linking to issues 
Addresses #6536 and #6628.
 2020-07-28 09:43:07 -04:00
Sumana Harihareswara e898267d94 WIP fixing tabs spaces problem 2020-07-28 09:35:14 -04:00
Sumana Harihareswara 483dec270a WIP formatting 2020-07-28 09:33:31 -04:00
Sumana Harihareswara af0633e633 WIP formatting and links 2020-07-28 09:29:23 -04:00
Sumana Harihareswara 0ec91a541f WIP: moving test suggestions from other issue 
Related to #8099.
 2020-07-28 09:23:59 -04:00
Sumana Harihareswara 2142d04c72 WIP: improvements to list of things to test 2020-07-28 09:23:59 -04:00
Sumana Harihareswara 5bf4c56376 WIP: update info about release plan 2020-07-28 09:23:59 -04:00
Sumana Harihareswara 0783460a7e Improve coverage of conflicts from installed packages 2020-07-28 09:23:59 -04:00
Sumana Harihareswara d8d6da6985 Docs: add item about constraints files 2020-07-28 09:23:59 -04:00
Sumana Harihareswara d51fd4799c docs: include force-reinstall item 2020-07-28 09:23:59 -04:00
Sumana Harihareswara f74c764c85 Work in progress: docs: 20.2 beta testing guide 2020-07-28 09:23:59 -04:00
Nguyễn Gia Phong 7a0061d886 Update docs for setting verbose/quiet in config file or env var 
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
Co-authored-by: Prashant Sharma <prashantsharma161198@gmail.com>
Co-authored-by: Xavier Fernandez <xav.fernandez@gmail.com>
 2020-07-28 10:13:14 +07:00
Laurie O bac3c8eb9a
Explicitly note that pip does not vendor keyring 2020-07-28 10:42:01 +10:00
Emmanuel Arias b6c99afade
Add note explaining the Docs PR deploy (#8622) 
Add a note to explain that documentation is
deployed readthedocs for each PR.
 2020-07-27 18:26:41 +02:00
Laurie O 9eb9319f7e
Document keyring support for index basic-auth 2020-07-27 20:59:31 +10:00
Emmanuel Arias 9671830c3e
Update docs/html/user_guide.rst 
Co-authored-by: Julian Berman <Julian@GrayVines.com>
 2020-07-25 18:15:01 -03:00
Emmanuel Arias f887252d33
use global instead of system-wide specific on doc that global config file is shared by all python installation 2020-07-25 14:03:31 -03:00
Emmanuel Arias 44bb7164dd
Fix description of config files User Guide 
This PR make consitence User Guide with pip config file
 2020-07-25 09:57:45 -03:00
Srinivas Nyayapati 168460a8e0 fix url example 2020-07-18 12:25:15 -04:00
Srinivas Nyayapati 6ea15755eb update based on review 2020-07-18 12:23:22 -04:00
Srinivas Nyayapati eb6cc7f439 Add examples on how to install package extras and sdists to docs 2020-07-18 12:23:22 -04:00
Srinivas Nyayapati d6ac9a07a2 fix hyper link in patch 2020-07-15 16:31:59 -04:00
Srinivas Nyayapati c56f93539c Add references to get started with Git 2020-07-15 15:39:49 -04:00
Chris Hunt 9a10d82b29
Merge pull request #8561 from pypa/8512-feature-flag-docs 
Add feature flag documentation
 2020-07-14 19:41:41 -04:00
Nicole Harris 061d9fcdec
Update docs/html/development/release-process.rst 
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
 2020-07-09 21:53:30 +01:00
Nicole Harris ba44cc2e72 Add feature flag documentation 2020-07-08 21:26:25 +01:00
Nicole Harris 3c38110700 Add resolver docs 2020-07-07 11:14:38 +01:00
Paul Moore b321967ab9
Merge pull request #8376 from deveshks/fix-config-example 
Fixed example for defining multiple values for supported options
 2020-06-16 10:59:21 +01:00
Devesh Kumar Singh 6446de93bf Update example text to include --pre 2020-06-11 15:11:00 +05:30
Devesh Kumar Singh 91270545d0 Clarify global and per-requirement options in pip install docs 2020-06-11 14:59:46 +05:30
Stéphane Bidoul cc48c07b64
Merge pull request #8364 from rkm/mailing-list-updates 
replace links to pypa-dev mailing list
 2020-06-09 23:00:27 +02:00
Devesh Kumar Singh 885e5f9552 Fixed example for defining multiple values for supported options 2020-06-02 14:17:43 +05:30
Noah Gorny 7494d70356 docs: Improve prefix calculation of reqfile option autogeneration 2020-06-01 21:56:59 +03:00
Noah Gorny a80d5426ca docs: Reqfile options are now generated automatically 2020-06-01 21:56:59 +03:00
Pradyun Gedam 549a9d11a1
Merge pull request #8148 from NoahGorny/improve-dev-docs 
docs: getting-started: Improve running pip from source tree section
 2020-05-31 23:10:34 +05:30
Ruairidh MacLeod 869149d204 replace links to pypa-dev mailing list 2020-05-30 11:47:01 +00:00
Noah Gorny c38f962cfc docs: getting-started: Improve "running pip from source tree" section 
Also add news entry
 2020-05-29 10:24:45 +03:00
Sumana Harihareswara 3f76479c60 Update mailing list link in documentation 
Per https://groups.google.com/d/msg/pypa-dev/rUNsfIbruHM/LCEx-CB5AgAJ
the pypa-dev Google Group is now decommissioned.
Pointing to distutils-sig instead.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
 2020-05-28 16:31:47 -04:00
Pradyun Gedam 7e71ddb229
Merge pull request #8112 from deveshks/remove-appveyor-refs-from-doc 2020-05-23 17:05:26 +05:30
Pradyun Gedam bc9b1d9a23
Merge pull request #8309 from pradyunsg/ci/cleanup-2020-05 2020-05-23 16:59:24 +05:30
Pradyun Gedam 3ac13ee754
Add back Python 3.5 2020-05-23 10:38:07 +05:30
Pradyun Gedam 3ffd0305d9
Update CI documentation to reflect current realities 2020-05-23 06:01:22 +05:30
Pradyun Gedam d1c68bae7c
Skip integration tests for Py3.{5,6,7} on Windows CI 2020-05-23 05:53:11 +05:30
Pradyun Gedam 0bd624275d
Revert "build in place" 
This reverts commit 88e6e6bc5c.
 2020-05-13 02:50:10 +05:30
Hugo 64b9eddfa4 Reference 'pip cache' in the 'pip install' caching section 2020-04-29 18:22:35 +03:00
Devesh Kumar Singh 6ec16f540f Add azure pipelines and github actions to contributing doc 2020-04-27 13:20:01 +05:30
Pradyun Gedam 45f762eb7b
Merge pull request #7780 from AndydeCleyre/bugfix/7728 2020-04-27 12:51:54 +05:30
Pradyun Gedam daff81124a
Merge pull request #8087 from pradyunsg/document-python-2-drop-date 2020-04-23 00:43:26 +05:30
Devesh Kumar Singh e84699fe0e Remove appveyor CI references from docs 2020-04-23 00:33:28 +05:30
Pradyun Gedam c244314318
Merge pull request #8106 from brainwane/resolver-testing-documentation 2020-04-23 00:29:50 +05:30
Sumana Harihareswara 2cdde76954 Slightly polish contributor documentation 
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
 2020-04-21 11:20:42 -04:00
Sumana Harihareswara b56de93bc9 Add resolver testing doc link 
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
 2020-04-21 11:07:21 -04:00
Pradyun Gedam a531a15376
Merge pull request #8093 from pradyunsg/better-docs-for-in-place-builds 2020-04-20 03:27:44 +05:30
Pradyun Gedam 756b02f712
Improve documentation for in-place builds 2020-04-20 02:23:22 +05:30
Pradyun Gedam ba46eb92cf
"Release Notes" -> "Changelog" 2020-04-20 00:29:38 +05:30
Pradyun Gedam a75f2fa31d
Document pip 21.0 as end of Python 2 support 2020-04-19 23:42:39 +05:30
Pradyun Gedam f458573de6
Merge pull request #7882 from sbidoul/build-in-place-7555-sbi 
Build local directories in place
 2020-04-13 21:33:02 +05:30
Pradyun Gedam bdff935570
Merge pull request #6391 from duckinator/pip-cache 
Add 'pip cache' command
 2020-04-13 19:53:05 +05:30
Pradyun Gedam 9e02a1a97f
Reword based on suggestion 
Co-Authored-By: Noah <noah.bar.ilan@gmail.com>
 2020-04-13 04:55:57 +05:30
Pradyun Gedam 7dde527ac9
Merge pull request #7948 from pradyunsg/docs/conventions-update-1 
Update docs conventions based on recent experience
 2020-04-13 04:54:18 +05:30
Pradyun Gedam 113884b3a2
Drop entire section on Indentation 2020-04-12 19:13:25 +05:30
Stéphane Bidoul 88e6e6bc5c
build in place 2020-04-12 12:00:57 +02:00
Ellen Marie Dash 2d978309a2 [commands/cache] Minor clean-up. 
- Consistently use singular 'cache' (not plural 'caches').
- Remove unnecessary uses of the word 'currently'.
- Use 'file(s)' instead of 'files', to account for case of only one file.
- Use .format() when appropriate.
- Minor cleanup of `pip cache`-related files in docs/.
 2020-04-01 16:54:42 -04:00
Ellen Marie Dash 94a6593a59 [commands/cache] Add HTML docs for pip cache. 2020-04-01 16:54:04 -04:00
Ellen Marie Dash 8ae71adbea [commands/cache] Add docs for 'pip cache' command. 2020-04-01 16:54:03 -04:00
Devesh Kumar Singh 8f0dbec573 Updated clarification on unsafe urls 2020-04-01 19:38:41 +05:30
Devesh Kumar Singh d166adaee5 Merge branch 'master' into remove-obsolete-git-urls 2020-04-01 19:36:31 +05:30
Pradyun Gedam 0c30b45ce2
Merge pull request #7947 from pradyunsg/docs/nicer-formatting-vcs-support 
Use a code block for denoting directory structure
 2020-04-01 18:15:03 +05:30
Devesh Kumar Singh 9af42c27e8 Clarification on removed urls 2020-03-31 20:40:57 +05:30
Pradyun Gedam 91444f546e
Avoid Sphinx from justify-expanding code block 2020-03-31 20:13:15 +05:30
Pradyun Gedam 13817bf450
Update docs conventions based on recent experience 2020-03-31 19:52:55 +05:30
Pradyun Gedam c5908bd222
Use a code block for denoting directory structure 2020-03-31 18:45:05 +05:30
Devesh Kumar Singh 6fbf80a9f9 Remove vcs urls pertaining to git protocol from docs 2020-03-31 13:35:05 +05:30
cjc7373 c388315bc0 Clarify the usage of --no-binary and --only-binary command 2020-03-30 16:57:24 +02:00
Nguyễn Gia Phong 03f0ff440d Fix rst syntax in Getting Started guide 2020-03-29 15:17:42 +02:00
Devesh Kumar Singh 326efa5c71 Defining multiple values for supported options 2020-03-28 14:35:31 +01:00
Devesh Kumar Singh be2268ee87 Clarify use of freeze in pip in program example 2020-03-28 16:48:22 +05:30
Sumana Harihareswara f116e0c4ff Add docs link to resolver improvement blog post 
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
 2020-03-27 16:25:45 -04:00
Pradyun Gedam 4e81af49eb
Architecture Documentation: Configuration deep dive 
Merge pull request #7858 from pradyunsg/docs/deep-dive-configuration
 2020-03-28 01:49:55 +05:30
Pradyun Gedam 98f1a9576a
Improve description of Configuration.{load_only,isolated} 2020-03-27 17:19:21 +05:30
Pradyun Gedam ba81cc9bd0
Move Configuration.get_value to earlier section 2020-03-27 17:19:20 +05:30
Pradyun Gedam cb7b3af06f
Put the bracketed text in the correct position 2020-03-27 17:19:20 +05:30
Pradyun Gedam b0687a0aa7
Fix the bullets 2020-03-27 17:19:08 +05:30
John T. Wodder II c42b5d3716 Change docs link from PEP 301 to PEP 503 2020-03-25 23:57:18 -04:00
Paul Moore 69cc55831d
Merge pull request #7878 from onlinejudge95/bug/7683 
Rephrases documentation
 2020-03-25 08:02:42 +00:00
onlinejudge95 4d0a55ee6f Address minor comments 2020-03-24 19:32:37 +05:30
Pradyun Gedam 9229de9858
Switch to an API-describing format 2020-03-24 15:43:34 +05:30
Devesh Kumar Singh 145c189a49 Add a What Next page in getting started 2020-03-24 15:12:12 +05:30
Pradyun Gedam 8eb33303fc
Document the two lifecycles of Configuration 2020-03-23 17:47:00 +05:30
Pradyun Gedam 96ea512de1
WIP: Add better overview for configuration deep dive 2020-03-23 17:46:44 +05:30
Pradyun Gedam a83ea610d2
WIP: Add initial draft of configuration deep dive 2020-03-23 17:46:36 +05:30
onlinejudge95 4d6a982976 Addresses PR comments 2020-03-21 14:28:34 +05:30
onlinejudge95 adf3dc8572 Fixes linting checks 2020-03-21 13:43:54 +05:30
onlinejudge95 3cadfd2e80 Addresses PR comments 2020-03-21 13:30:26 +05:30
onlinejudge95 e42929dcf6 Rephrases documentation 2020-03-21 12:49:15 +05:30
Pradyun Gedam 9e15cd49f2
Merge pull request #7767 from RDIL/copyright-docs 
Added copyright doc
 2020-03-18 16:31:24 +05:30
Pradyun Gedam 5c9c68c10f
WIP: Add initial draft for CLI deep dive 2020-03-14 00:46:53 +05:30
Pradyun Gedam 9351c61b82
Fix typo in package-finding.rst 2020-03-14 00:29:19 +05:30
Jason R. Coombs 3511d3d493 Convert the remaining '%' formatters to '.format'. Fixes #6973. 2020-03-06 12:43:03 -05:00
Pradyun Gedam 9e884a46f6
Merge pull request #7755 from pradyunsg/docs/conventions 
Add initial draft for documentation conventions
 2020-02-26 03:40:27 -08:00
Pradyun Gedam 80b952b6e2
Apply suggestions from code review 
Co-Authored-By: Christopher Hunt <chrahunt@gmail.com>
 2020-02-25 04:06:25 +05:30
Andy Kluger 42814f0124 Fix docs: comment stripping comes _after_ line continuation processing 2020-02-24 15:28:16 -05:00
Reece Dunham 3fb48183c3
Add :orphan: 2020-02-22 10:10:28 -05:00
Reece Dunham e093938d15 Bump year 
Signed-off-by: Reece Dunham <me@rdil.rocks>
 2020-02-21 22:50:46 +00:00
Reece Dunham 9d281112e3 Added copyright doc 
Signed-off-by: Reece Dunham <me@rdil.rocks>
 2020-02-21 22:39:08 +00:00
Anudit Nagar 082c0f01d2
Update old-style formatting to new-style formatting (#7762) 2020-02-21 21:48:14 +05:30
Pradyun Gedam 82b4566a7f
Merge pull request #7611 from webknjaz/testing/gh-actions-ci-cd-linters 
Adjust GitHub Actions CI/CD linters
 2020-02-19 20:03:46 +05:30
Pradyun Gedam c93c5e84bf
Add initial draft for documentation conventions 2020-02-18 11:01:27 +05:30
Pradyun Gedam 0f513ddbea
Synchronize upgrade-options.rst 2020-02-18 10:56:55 +05:30
Pradyun Gedam e648e00dc0
pip is spelt all-lowercase 2020-02-18 10:55:16 +05:30
Pradyun Gedam 59c47ab88c
Link to our architecture documentation 2020-02-18 10:55:16 +05:30
Pradyun Gedam 2d87d5f689
Enforce blank lines before directive-blocks 2020-02-18 10:55:16 +05:30
Pradyun Gedam 4089cdd0de
Enforce 1 blank line before h3 2020-02-18 10:55:16 +05:30
Pradyun Gedam 404f89305e
Enforce 2 blank lines before h2 2020-02-18 10:55:15 +05:30
Pradyun Gedam 49b978dd8a
Make heading style consistent 2020-02-18 10:55:15 +05:30
Pradyun Gedam 9944ad114f
Make page-title heading style consistent 2020-02-18 10:55:11 +05:30
Paul Moore 5da3a7d3cf Add documentation to internals on upgrade options 2020-02-17 14:02:44 +00:00
Sviatoslav Sydorenko 476bcb8d7c
📝 Document running vendoring check @ GitHub CI/CD 2020-02-03 12:25:56 +01:00
Bhavam Vidyarthi 7534dccd6c
Removed tests/scripts folder with its contents (#7680) 2020-02-03 05:17:02 +08:00
Andre Aguiar 96ce5236f1 Capitalize "URL" in user guide 2020-01-30 20:52:49 -05:00
Pradyun Gedam b411cdbdf5
Azure Pipelines: Test Windows on Python 3.8 (#7320) 2020-01-13 12:33:43 +00:00
Chris Hunt a5f5d8fa81 Add Python 3.8 Windows Azure tests to CI docs 2020-01-12 19:54:47 -05:00
Christopher Hunt eeeecbe856
Merge pull request #7543 from sbidoul/deprecate-gitgitarobase-sbi 
Deprecate git+git@ form of VCS requirements
 2020-01-08 11:04:12 +08:00
Chris Hunt 927ea8be29 Replace AppVeyor with Azure in CI docs 2020-01-06 19:33:49 -05:00
Stéphane Bidoul (ACSONE) cf071dee55
Deprecate git+git@ form of VCS url 2020-01-02 19:20:29 +01:00
Christopher Hunt ab7e4769db
Merge pull request #7520 from chrahunt/maint/cross-platform-lints 
Run linters/docs on Windows and macOS
 2020-01-01 23:48:56 +08:00
Chris Hunt c9ab34a945 Fix docs build on Windows 
Sphinx expects the "document name" field to be normalized with respect
to slashes (all /), so we now do this in a portable way for Windows.
 2019-12-28 18:21:46 -05:00
Eitan Adler 98543b2caa getting_started: remove a a duplicate word 2019-12-28 15:08:39 -08:00
Remi Rampin 04d8841ace Update links in docs 2019-12-11 22:23:34 +01:00
Preet Thakkar cc96315273 Added note about # noqa in getting-started.rst 2019-12-06 15:10:33 +05:30
Christopher Hunt 830e29e189
Move wheel to operations.install.wheel (#7421) 
* Update documentation

For now just fixing the paths and adding a sub-package docstring.
 2019-12-04 06:02:39 +08:00
Keith Maxwell b7a4b022d6 Better document the requirements file format (#7386) 
Change the documentation for the requirements file format so that it
matches the implementation [0]. Also change the order of the options in
the implementation so that the documentation reads better.

Before this change the documentation included an incomplete list of
supported options.

This change adds the missing options and changes the order to match, so
that the two locations are easier to keep in sync. After this change the
list in the documentation matches SUPPORTED_OPTIONS in
src/pip/_internal/req/req_file.py

[0]: https://github.com/pypa/pip/blob/master/src/pip/_internal/req/req_file.py#L60
 2019-11-20 12:45:21 +08:00
Aakanksha Agrawal a3bcaa4ea0 Explain how to get source code in getting started (#7197) 2019-11-18 09:46:19 +08:00
Swat009 844fcc1cc5 Updated info about pip support for url_req portion of PEP508 (#6768) 2019-11-18 09:45:35 +08:00
Yeray Diaz Diaz ffe0e27c2b Update link to peer review PDF (#7360) 2019-11-18 09:42:55 +08:00
Christopher Hunt 4c1a7cda5a
Merge pull request #7201 from aniruddha2000/basic_cred 
Describe basic auth credentials in documentation
 2019-11-13 10:52:50 +08:00
Christopher Hunt 2de81affb8
Merge pull request #7348 from sinoroc/fix-doc-links-index-options 
Fix documentation links for index options
 2019-11-13 10:24:30 +08:00
Chris Hunt 8f60e8835a Move URL in basic auth docs 2019-11-12 21:05:42 -05:00
sinoroc 72e8510f3b Fix documentation links for index options 
In the documentation the links for the pip commands index options
are mixed up.

The index options are common to multiple commands, but in the
documentation they should be specific to a command for the links to
point to the right chapter.

GitHub: #7347
 2019-11-13 00:01:19 +01:00
Aniruddha Basak cc57a18548 Correct the link referring the issue 3236 2019-11-12 18:30:51 +05:30
Jiashuo Li 530c1d7344
Add double quotes to pip install from VCS 2019-11-12 10:32:21 +08:00
Pradyun Gedam 6c04feff1d
Sort applicable candidates before computing best candidate (#7332) 2019-11-11 22:10:57 +05:30
Christopher Hunt 8453fa5a64
Merge pull request #7073 from cjerdonek/remove-get-pages 
Change CollectedLinks to store project page URLs
 2019-11-11 11:00:19 +08:00
Christopher Hunt 105e7bd0b1
Merge pull request #6372 from kx-chen/document-no-warn-script-location 
Document enabling --no-warn-script-location
 2019-11-11 10:45:46 +08:00