Commit Graph

1122 Commits

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