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
Chris Jerdonek
9bd0db2945
Update the PackageFinder architecture document.
2019-11-10 21:27:13 -05:00
Kai Chen
dd0ba3d185
Document enabling --no-warn-script-location with falsy values
...
Closes https://github.com/pypa/pip/issues/6209
2019-11-10 21:09:30 -05:00
Pradyun Gedam
997db009b2
Update documentation for package finding
2019-11-10 14:12:56 +05:30
Pradyun Gedam
1308270723
Switch to using just nox commands in the release process
2019-11-10 12:18:20 +05:30
Aniruddha Basak
0d0ee9b407
Modify URL and give information of enterprise environments supporting older Pythons and pips
2019-11-09 15:34:58 +05:30
Stéphane Bidoul (ACSONE)
9cad519521
Cache wheels built from immutable Git requirements
...
Cache wheels that are built from Git requirements
that contain an immutable revision (i.e. a sha).
2019-11-03 22:54:33 +01:00
Pradyun Gedam
ca53a8bc56
Document the simplified release process
2019-11-03 14:48:21 +05:30
Christopher Hunt
553824477d
Merge pull request #7195 from ananyo2012/utf8-doc
...
Document that "coding: utf-8" is supported in requirements.txt
2019-11-01 11:26:48 +08:00
Ananya Maiti
bb047aa263
Document that "coding: utf-8" is supported in requirements.txt
...
Fixes #7182
2019-10-31 20:27:00 +05:30
Xavier Fernandez
01c953b95d
docs: Add basic documentation about our CI setup
2019-10-31 15:39:07 +01:00
Aniruddha Basak
69e0178a54
Add description about the examples
2019-10-25 16:40:05 +05:30
Aniruddha Basak
23bac8f574
Add https:// in the login token example
2019-10-25 00:51:40 +05:30
Christopher Hunt
ccfd119673
Merge pull request #7241 from xavfernandez/update_release_doc
...
Update release doc
2019-10-20 09:16:40 -04:00
Xavier Fernandez
7c218c9a80
Update the patch release process
2019-10-19 22:53:29 +02:00
Xavier Fernandez
cb8564c6e1
docs: add notes regarding `get-pip.py
` during the release
2019-10-19 22:52:45 +02:00
Pradyun Gedam
6d96b85388
Update the URL fragment to not include "py"
...
I'm making this change since it's unlikely that folks would've linked to
this specific section, and if they did, this isn't exactly user facing
documentation, so I wouldn't hold this to the same standard.
2019-10-19 22:31:45 +05:30
Pradyun Gedam
2399a26cb1
Remove remaining references to index.py
2019-10-19 22:29:19 +05:30
Pradyun Gedam
3846da7f71
Update docs/html/development/architecture/package-finding.rst
...
Co-Authored-By: Ellen Marie Dash <the@smallest.dog>
2019-10-19 22:24:53 +05:30
Pradyun Gedam
6ea84c6145
Update docs to refer to index as a sub-package
2019-10-19 22:22:12 +05:30
Aniruddha Basak
f7a0065636
Add block in the code snippet
2019-10-19 22:21:59 +05:30
Aniruddha Basak
4d968f5ff3
Add url with special charecter and single part token
2019-10-19 22:06:11 +05:30
Christopher Hunt
fde92e72a4
Merge pull request #7219 from hugovk/add-3.8
...
Declare support for Python 3.8
2019-10-17 09:22:03 -04:00
everdimension
3b8e2f3749
Rephrase installation instructions
...
Make it a bit more clear that the goal is to just
download the get-pip.py file and that the curl command
is not required
2019-10-16 22:04:23 +02:00
Shovan Maity
852d996c40
(improve doc): add command to run test in parallel ( #7189 )
2019-10-15 22:50:38 +02:00
hugovk
d65bf5021a
Update docs about Python 3.8
2019-10-15 20:06:29 +03:00
Aniruddha Basak
5fb94298cf
Fix whitespace
2019-10-15 12:22:47 +05:30
Aniruddha Basak
3e326a017b
Fix typo
2019-10-15 12:09:42 +05:30
Xavier Fernandez
8df9329396
Add release target
2019-10-14 14:23:00 +02:00
Aniruddha Basak
1e46e6c48d
Added description for basic auth credentials
2019-10-14 17:21:24 +05:30
Christopher Hunt
5a997b7509
Merge pull request #7065 from chrahunt/pr-5955
...
Explicit support for hg+file
2019-10-06 09:39:42 -04:00
gpiks
f006a7b262
Clarify --no-binary
when enumerating packages and add an example
...
Minor tweak to `--no-binary` documentation to specify that when
enumerating packages, the colons are not needed. Additionally,
add an example to demonstrate building a wheel from source.
2019-09-30 22:22:35 -04:00
John Paton
d6128bebe5
change filename in docs
2019-09-30 09:56:44 +02:00
John Paton
6b57c1f5df
Move outdated outside utils and rename ( pypa/pip#6532 )
2019-09-30 09:56:44 +02:00
Chris Hunt
dc50948c3c
Single backticks to double backticks in triage guide
2019-09-29 11:27:06 -04:00
Pradyun Gedam
6b74f2eccb
Initial triage guide ( #6868 )
2019-09-29 12:32:27 +05:30
Pradyun Gedam
5713057db2
Rewrap all of user_guide.rst at 80 characters
2019-09-26 13:21:40 +05:30
Pradyun Gedam
b926290a50
Merge pull request #7078 from pradyunsg/revamp-linting-processes
...
Revamp linting processes
2019-09-25 20:57:36 +05:30
Pradyun Gedam
45bc66ae1a
Add a space I missed.
2019-09-24 22:13:14 +05:30
Pradyun Gedam
c47e1b6e5d
Enable rst-backticks for ReST files and NEWS fragments
2019-09-24 18:03:22 +05:30
Pradyun Gedam
7224a1155c
Enable trailing-whitespace
2019-09-24 18:03:22 +05:30
Pradyun Gedam
6f8c29aa77
Enable end-of-file-fixer
2019-09-24 18:03:22 +05:30
Pradyun Gedam
0a25c7d4a6
Document that pre-commit is used for linting
2019-09-24 18:03:22 +05:30
Pradyun Gedam
3b0f2c32dd
Make the role of tox, in test running, clearer
2019-09-24 17:07:10 +05:30
Pradyun Gedam
2bbbc0756a
Oops! I'd missed a word.
2019-09-24 17:07:10 +05:30
Pradyun Gedam
96fd796334
Some hand-holding to tell folks to install Python
2019-09-24 17:07:10 +05:30
Pradyun Gedam
d0df9d375f
Drop references to lint-py2 and mypy in documentation
2019-09-24 17:03:39 +05:30
Chris Hunt
05964ead48
Address previous review comments
2019-09-22 11:10:25 -04:00
Adam Tse
3f98ee4250
Explicit support and tests for hg+file
scheme for pip install
.
2019-09-22 11:04:23 -04:00
Chris Hunt
2a4cfcb021
Address review comments.
2019-09-20 20:09:49 -04:00
Chris Hunt
a8996f25e5
Initial triage guide.
2019-09-20 20:09:49 -04:00
Christopher Hunt
cdbda9bfd3
Merge pull request #7022 from chrahunt/docs/triage-guide-1
...
Add triage guide document.
2019-09-19 07:48:19 -04:00
Chris Hunt
80339aab2c
Add WIP note
2019-09-19 01:53:02 -04:00
Christopher Hunt
82c2dd40eb
Merge pull request #6203 from vinicyusmacedo/fix-pep-508
...
Fix is_url from splitting the scheme incorrectly when using PEP 440's direct references
2019-09-16 09:52:40 -04:00
Chris Hunt
42cbd3c737
Add triage guide document.
...
Includes basic issue tracker info, as a first step towards the full
document.
2019-09-15 13:22:38 -04:00
Chris Jerdonek
ca4fc9e741
Update architecture/package-finding.rst.
2019-09-12 02:31:45 -07:00
Pradyun Gedam
79ce923e1a
Update documented invocations of generate commands
2019-09-05 12:40:34 +05:30
Pradyun Gedam
3b2d138400
Rename tox lint-py3
to tox lint
...
Merge pull request #6934 from pradyunsg/lint-python3-default
2019-08-27 17:09:01 +05:30
Pradyun Gedam
506a08bc38
Rename tox lint-py3
to tox lint
...
Also update references to it, in Travis CI config and in documentation.
2019-08-27 13:55:20 +05:30
Sumana Harihareswara
289af52b59
Add WIP note
2019-08-22 12:42:35 -04:00
Pradyun Gedam
9b82fcc9d8
Merge branch 'master' into architecture
2019-08-22 21:07:58 +05:30
Pradyun Gedam
f0d48d1897
Merge pull request #6901 from pypa/pradyunsg-docs-improve-note
...
Note that pip's internals can change at any time
2019-08-22 12:50:47 +05:30
Chris Jerdonek
e888587c68
Note that pip's internals can change at any time
2019-08-21 15:51:38 +05:30
Chris Jerdonek
8db3944a64
Add initial architecture section for index.py and PackageFinder.
2019-08-20 22:49:30 -07:00
Sumana Harihareswara
9b0383ea6c
WIP improve linking and formatting
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
72094355dc
WIP polish formatting
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
f6a4c71c95
WIP fixing errors
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
165e5a33ff
WIP reorganizing
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
c03335502a
WIP formatting of source section
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
7e51405806
WIP reformatting as nested list
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
8f2d28b563
WIP to squash
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
7662d840ed
Polish formatting and wording
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
4b8ecd6f2d
Add architecture overview.
2019-08-13 19:21:01 -04:00
Vinicyus Macedo
16af35c613
Adding improvements to the _get_path_to_url function
2019-08-12 14:32:03 -03:00
Pradyun Gedam
7c319ad74a
Add a skeleton for architecture documentation ( #6836 )
2019-08-07 02:41:00 +05:30
Pradyun Gedam
5280483c06
Clarify who we welcome help from
2019-08-07 02:40:08 +05:30
Paul Moore
e4c32b9917
Merge pull request #6770 from omry/master
...
exclude '.tox', '.nox' from being copied during 'pip install .'
2019-08-05 23:29:02 +01:00
Pradyun Gedam
1429a55f40
Add a skeleton for architecture documentation
2019-08-05 17:51:28 +05:30
Omry Yadan
6dd5727773
responded to comments
2019-08-03 11:14:36 -07:00
Omry Yadan
ec47c866c8
updated docs
2019-08-03 10:31:42 -07:00
Chris Jerdonek
1f09e67f34
Only import a Command class when it is actually needed.
...
This resulted in an approximate 24% speed-up of a vanilla `pip`
invocation on one system (0.477 secs before, 0.363 secs after).
2019-07-26 23:30:26 -04:00
Pradyun Gedam
8de817c7ed
Reword as suggested in PR review
2019-07-20 09:37:48 +05:30
Pradyun Gedam
6057e6c344
Document how Python 2.7 support will be handled
2019-07-20 09:37:47 +05:30
Xavier Fernandez
ab10b8c328
debug: add warnings about its provisional status
2019-07-18 14:39:12 +02:00
Xavier Fernandez
d70edc8a95
docs: add basic documentation for pip debug
2019-07-18 14:39:12 +02:00
Xavier Fernandez
8f45aee97a
Fix line length & don't flake8 docs in python 2
2019-07-18 14:37:31 +02:00
Eli Schwartz
1350b95dee
docs: fix manpage generation
...
This was broken in commit 20f672c4e6
,
which reorganized the conf.py file into the html subdirectory. See:
https://github.com/pypa/pip/pull/5724
https://github.com/readthedocs/readthedocs.org/issues/1543
This broke the relative manpage globbing because Sphinx will os.chdir()
into the directory location of conf.py before evaluating it, so the
globbing returned nothing at all. As a result, while the main pip(1)
manpage continued to be built, no pip-*(1) subcommand manpages were
built.
2019-07-17 23:53:50 -04:00
Eli Schwartz
f2cbcd190f
docs: check that the subcommand manpages are actually found and being used
2019-07-17 23:52:44 -04:00
Eli Schwartz
f3f63c0f82
docs: fix manpage names being truncated
...
In commit d2e7377c0f
, the documentation
directories were reorganized, resulting in `fname_base` (the path that
Sphinx looked for source files) to no longer expect the leading 'man/'.
This was always also stripped from the `outname`, which now strips four
characters twice over.
Fix by reducing the stripped length to only the length of the prefix in
fname_base itself.
2019-07-17 22:53:17 -04:00
Hugo
2c1010ee96
Drop support for EOL Python 3.4
2019-07-07 11:45:16 +03:00
Pradyun Gedam
a8c66dc5d7
Merge pull request #6007 from smartsammler/fix-iss4733
...
Fix #4733 by deleting the failing example
2019-07-06 09:18:58 +05:30
Pradyun Gedam
f196814b71
Soften language in note for Installation Order
2019-06-16 19:34:19 +05:30
Pradyun Gedam
3c17e280f5
Add another colon to make it ReST directive
2019-06-16 18:27:00 +05:30
Pradyun Gedam
61c4b6159c
Add a disclaimer to the "Installation Order" section ( #6604 )
2019-06-16 17:43:28 +05:30
Pradyun Gedam
cbb2a5e6ad
Add a disclaimer to the "Installation Order" section
...
This section has caused a lot of user confusion since PEP 517/518. It seems that users are referring to this section for advice about how to deal with build time issues, which contains statements that do not hold true for build requirements.
2019-06-13 16:57:07 +05:30
Chris Jerdonek
d72758394d
Fully support --trusted-host inside requirements files.
2019-06-13 01:21:05 -07:00
Abhinav Sagar
107258da0b
Document issue tracker triage as a contribution area ( #6569 )
2019-06-05 06:36:32 +05:30
Stéphane Bidoul (ACSONE)
99b64ba80f
docs: mention installing from git refs
2019-05-18 12:02:28 +02:00
ABHYUDAY PRATAP SINGH
a731e7e37d
Docs: capitalize "URL"
2019-05-10 22:52:21 +02:00
Pulkit Goyal
d2742a9049
Improve sentence about PyPI package search ( #6476 )
2019-05-07 14:30:39 -04:00
Chris Jerdonek
a163ae5af1
Fix some formatting issues in the pip-install docs ( #6432 )
2019-05-07 09:13:56 -04:00
Albert Tugushev
7130b1d0e0
Fix option name for smart quotes in sphinxdoc conf ( #6422 )
...
Also configure the smartquotes_action to exclude dashes from transformation.
See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
2019-04-21 09:51:42 -07:00
Caleb Martinez
ac9010e87c
Allow adding a custom string to pip's User-Agent via an environment variable ( #5550 )
2019-03-31 02:37:02 -07:00
Pi Delport
5f3c56e188
Fix some typos
2019-03-12 21:54:18 +01:00
jakirkham
9360648b34
Remove extra .
2019-02-28 13:10:24 -05:00
Pradyun Gedam
45d16ac83e
Remove note about flake8 noqa comments
2019-02-25 22:10:00 +05:30
Nick Coghlan
682cff7230
Fix #6163 : Default to setuptools.build_meta:__legacy__
...
The main setuptools PEP 517 backend is intended for
explicit usage in `pyproject.toml`, when the project
authors can ensure that their `setup.py` runs without
that directory being implicitly on `sys.path`.
For implicit usage, setuptools now offers a separate
legacy backend that more closely mimics direct
execution of the `setup.py` script.
2019-02-06 20:57:57 +10:00
Pradyun Gedam
98654c8761
Replace link to virtualenv-users with Discourse Packaging channel
2019-01-29 14:09:47 +05:30
Thea Flowers
dc5c13d547
Address comments
2019-01-28 10:05:23 -08:00
Thea Flowers
f7d84b117e
Update index
2019-01-25 11:27:55 -08:00
Albert-Guan
465261a828
Document that empty environment variables are not treated as false ( #5953 )
2018-11-24 19:30:41 +05:30
Donald Stufft
51eb885e78
Add a release task to upgrade CPython's bundled pip
2018-11-19 07:39:10 -05:00
Paul Moore
3a77bd667c
Merge pull request #5743 from pfmoore/pep517
...
PEP 517 implementation
2018-11-15 09:32:17 +00:00
Paul Moore
cf4d84e58f
Address doc review comments
2018-11-14 13:15:55 +00:00
Pradyun Gedam
507b90e117
Merge pull request #5949 from kynan/extend-docs
...
Add instructions for running pip from source to docs
2018-11-13 21:21:43 +05:30
Julian Gethmann
f92ac73ccd
Fix pypa#4733 by changing the failing example
...
This example did not make sense unless it was possible to install specify a
version of a package one installs referencing by the path (here: `.`).
A new example for the local installation with an extra has been added
instead.
2018-11-12 17:08:45 +01:00