Commit Graph

1122 Commits

Author SHA1 Message Date
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