1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
Commit graph

1469 commits

Author SHA1 Message Date
sandeepkiran-js 5288298c7b Update index.md 2022-05-23 21:35:22 +05:30
Andrew Shymanel e45c1a34b2
fixed typos
Fixed small typos
2022-05-14 23:32:48 +03:00
wim glenn 6efe70858c mention that detail.. 2022-04-29 22:38:38 -05:00
Paul Moore 962b0738fd Add documentation 2022-04-22 10:42:16 +01:00
Frost Ming 6a1ed5c0f4
Add completion script for powershell (#9025) 2022-04-15 09:32:42 +01:00
Edgar Ramírez e4376ed128
docs: Add section on PEP 508 support for build system requirements (#10735) 2022-04-13 00:25:43 +01:00
Martin Fischer c394bf6c0d
Fix RST admonition & add missing inline code formatting (#10747) 2022-04-12 21:02:41 +01:00
Pradyun Gedam e679df4051
Merge pull request #11001 from pradyunsg/remove-out-of-tree
Drop out-of-tree/in-tree build transition flags
2022-04-09 16:02:40 +01:00
Pradyun Gedam 79ef8f313a
Translate issue-triage guide to Markdown
This avoids the weird linter issues we're having here.
2022-04-08 12:56:16 +01:00
Pradyun Gedam 508737baf4
Add triage notes about redistributors 2022-04-08 12:53:50 +01:00
Pradyun Gedam 428e886ad6
Drop out-of-tree/in-tree build transition flags
These were intended to help users transition when the default behaviour
changed to no longer perform out-of-tree builds. The transition is now
considered complete.
2022-04-08 12:20:36 +01:00
Tzu-ping Chung 182bac15f5
Merge pull request #10774 from gavindsouza/patch-1 2022-04-07 15:42:51 +08:00
Hugo van Kemenade 856a6ba117
Docs: Capitalise Y as the default for Proceed (#10969)
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
2022-03-18 05:38:07 +00:00
Diego Ramirez 07815fd76a
Fix a small typo in the docs
(a)abort (aabort?) -> (a)bort (abort)
2022-03-11 09:04:12 -06:00
Pradyun Gedam 4306edf4b1
Merge pull request #10957 from pradyunsg/better-caching-docs 2022-03-11 12:21:33 +00:00
Pradyun Gedam 8774f06e8c
Flesh out the cache management section
This provides information on using the `pip cache` command to do things.
2022-03-11 07:54:10 +00:00
Pradyun Gedam 9e1635c9d7
Document the location of pip's cache
This makes it easier for users to discover this information.
2022-03-11 07:52:36 +00:00
Georgy Pchelkin a7fc70455e --proxy option requires scheme, does not work without it
see also: 2b2ca40ccc
2022-03-09 16:59:22 +03:00
Pradyun Gedam 82aebdbfb8
Merge pull request #10899 from pradyunsg/docs/more-reference 2022-02-26 12:39:41 +00:00
Pradyun Gedam adc69cbe06 Add a dedicated topic page on "Secure Installs"
This moves the content about hash checking mode into here, along with
adding minor additional recommendation of using `--no-binary :all:`.
2022-02-18 13:58:46 +00:00
Pradyun Gedam 72d3009422 Move section on per-requirement build system overrides
This also adds some prominent warnings to the section, to discourage
users from using these options.
2022-02-18 13:58:46 +00:00
Pradyun Gedam 3bd30f2575 Improve Requirements File Format example 2022-02-18 13:58:46 +00:00
Pradyun Gedam ea8b8ed591 Add a dedicated topic page for local project installation
This should make this information more discoverable, while also
providing clearer guidance on what the difference between a "regular"
install vs an "editable" install is.
2022-02-18 13:55:18 +00:00
Pradyun Gedam 8181af294b Add a dedicated page for requirement specifiers
This should make this information more discoverable.
2022-02-18 13:14:02 +00:00
Pradyun Gedam 5504e33700 Clarify that not-explicitly-supported platforms are unsupported
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
Co-authored-by: Xavier Fernandez <xav.fernandez@gmail.com>
2022-02-18 13:11:52 +00:00
Pradyun Gedam f2800b1cb8
Merge pull request #10892 from Ambro17/main 2022-02-18 12:30:00 +00:00
Pradyun Gedam 6e48ff710c
Merge pull request #10911 from yhay81/spelling 2022-02-18 12:27:41 +00:00
q0w d1ba927a74
Fix references in Markdown documentation files
MyST-Parser 0.17.0 reworked the link resolution logic, which has become
stricter and caught these issues.
2022-02-18 08:22:33 +00:00
Yusuke Hayashi d854b1e20d
fix: spelling mistakes and typos 2022-02-17 18:05:59 +09:00
Nahuel Ambrosini bb7c42fa99 🔧 Fix warning syntax to render as a warning 2022-02-08 22:47:16 -03:00
Matt Bacchi 3608b42ef0
Fix minor typo in vcs support doc 2022-02-02 17:04:53 -07:00
Pradyun Gedam 193259d3dc
Merge pull request #9674 from mobolic/document-that-overrides-disable-all-wheels 2022-01-31 07:50:35 +00:00
Pradyun Gedam d15393de79
Disallow Sphinx 4.4.0 in documentation builds
It introduces additional warnings that we aren't ready for.
2022-01-21 14:35:19 +00:00
gavin 55fab936d4 docs(fix): Unknown target name: "noxfile.py" 2022-01-18 12:05:38 +05:30
gavin 1b36ffc3b1 docs: Fix Typo {T=>N}ox 2022-01-17 23:22:36 +05:30
gavin 7b28428963 docs: Updated Pip Anatomy
* Updated root directory structure
   * Nox usages
   * Removed folders/files that don't exist anymore
* Updated src directory structure
2022-01-09 16:41:21 +05:30
Martey Dodoo 820c4f45bb Document that using overrides disables all wheels
Update documentation to state that using command line options on any
requirements will disable all usage of wheels. Since this is unexpected
behavior, move text to a warning.
2022-01-05 23:07:59 -05:00
Pradyun Gedam 3002881874
Merge pull request #10484 from pradyunsg/updated-direct-references-version 2021-12-04 18:59:46 +00:00
Pradyun Gedam e666842286
Merge pull request #10699 from cpawley/update-docs-10627 2021-12-03 20:14:13 +00:00
Chris Pawley 12493bc044
Update vcs-support.md
Updated from #egg based syntax to URL @  syntax found in pip freeze
2021-12-01 18:09:46 +01:00
Diego Ramirez 7ced6c583b Replace tox with Nox (CLI, docs) 2021-11-29 09:29:14 -06:00
Dane Hillard cee418172f Fix ill-formatted link to pip-tools
This link seems to have gone through a transform on the way out of
reStructuredText and was rendering as raw markup in the docs seen
[here](https://pip.pypa.io/en/latest/topics/dependency-resolution/#use-constraint-files-or-lockfiles).
2021-11-24 13:52:14 -05:00
Pradyun Gedam 2cf0c467cf
Change MacOS CI table from x86 support to arm64
It'll still be empty, but at least we're listing an architecture that is
supported.
2021-11-12 08:06:06 +00:00
Pradyun Gedam c6c6222f9e
Drop Python 3.9 from Windows CI 2021-11-12 08:04:57 +00:00
Hugo van Kemenade 0252c04a16 Drop support for soon-EOL Python 3.6 2021-11-08 12:02:16 +02:00
Pradyun Gedam 1d0f4eaf96
Merge branch 'main' into tweak-dev-getting-started 2021-11-05 12:22:19 +00:00
layday 844456ed36 Drop "setuptools" qualifier and link to PEP page for extras
Extras are not specific to setuptools anymore.
2021-11-05 11:42:07 +02:00
Pradyun Gedam 4144d6a7f9
Bump to Sphinx 4.2 and above
This should allow newer versions of Sphinx, which contain bugfixes for
Python 3.10 support.
2021-10-22 08:04:57 +01:00
Pradyun Gedam 902b9e7a1a
Merge pull request #10536 from pradyunsg/docs/fix-wordin 2021-10-18 20:27:15 +01:00
Pradyun Gedam b576329791
Fix documentation about when setup.py clean is run
It is only run on failure to build wheels.
2021-10-18 20:22:52 +01:00
Pradyun Gedam eddd6dde3b
Correct mistake in documentation on Unix configuration file paths
The order was flipped, which implied the wrong thing.
2021-10-17 15:08:08 +01:00
Pradyun Gedam fc6d7778a5
Merge pull request #10569 from aphedges/fix-typos 2021-10-15 19:25:34 +01:00
Pradyun Gedam aa89947b01
Improve our towncrier template, to do the right thing after releases
This also adds a bunch of comments, which should serve as useful guides
to future humans that work on these files.
2021-10-15 15:11:43 +01:00
Alex Hedges e1f81bfa4d Fix many typos 2021-10-11 15:48:17 -04:00
Pradyun Gedam a07bfb33a0
Merge pull request #10495 from sbidoul/out-of-tree-build-flag 2021-10-02 12:34:24 +01:00
Pradyun Gedam 989ec2136d
Merge pull request #10497 from pradyunsg/docs/build-system-reference
Add a dedicated "Build system interface" reference section
2021-09-30 07:09:27 +01:00
Pradyun Gedam 4d7d38a3c0
Addresss spelling nit
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-30 06:07:24 +01:00
Pradyun Gedam d6d72172e8
Rephase historical note about easy_install/setup_requires
It wasn't clear what "those dependencies" refers to.
2021-09-29 20:02:07 +01:00
Pradyun Gedam 25a31d49e5
Improve build system interface docs based on feedback
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-29 19:57:43 +01:00
Pradyun Gedam 229808807b
Update according to the PEP 660 implementation 2021-09-29 19:10:03 +01:00
Pradyun Gedam 76cdf8f7e1
Merge pull request #10521 from MrMino/debugging_pip_docs
Add a section about debugging to development docs
2021-09-29 18:37:44 +01:00
ziebam 6ab7dba97c Remove the redundant snippets 2021-09-29 17:15:04 +02:00
Blazej Michalik 2c75f20908 Add a section about debugging to development docs 2021-09-29 01:32:22 +02:00
ziebam 32879cd920 Change the docs to suggest .venv instead of venv 2021-09-29 00:06:48 +02:00
Pradyun Gedam d37aa211b4
Add a dedicated "Build system interface" reference section
This reworks a substantial portion of our existing build system related
documentation, putting it all in a single location.

There are certain areas that have been rephrased or rewritten:

- The setup.py interface is now considered an implementation detail.
- The setup.py interface is explicitly noted as a legacy interface, due
  for removal.
- The pyproject.toml interface now has clearer documentation on how it
  is used and how it operates.
- Clearer separation of `--use-pep-517` and `--no-build-isolation`, to
  make the difference between the two clearer.
2021-09-28 21:10:32 +01:00
Stéphane Bidoul 040cc391ba
Make in-tree-build the default
Add an out-of-tree-build feature flag to ease the transition.
2021-09-25 13:11:01 +02:00
Stéphane Bidoul 729eb5d627
Improve docs
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2021-09-21 11:18:01 +02:00
Stéphane Bidoul 5a38ee7ad2
Add docs example for pip list and editable installs 2021-09-21 11:18:01 +02:00
Pradyun Gedam 01279bdb02
Update when "direct references" got supported, to reflect reality 2021-09-18 09:46:42 +01:00
Pradyun Gedam 992d954ebd
Fix broken references in documentation 2021-09-18 09:11:42 +01:00
Pradyun Gedam 89326c8a9f
Merge pull request #10450 from pradyunsg/docs/requirements-format
Add a dedicated page for "Requirements File Format"
2021-09-17 16:51:58 +01:00
Pradyun Gedam 005fc1c027
Rephrase note about the file format
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-11 10:14:56 +01:00
Tzu-ping Chung 1ca0807890
Merge pull request #10430 from meowmeowmeowcat/patch-1 2021-09-11 04:01:29 +08:00
Pradyun Gedam 5f3a13d98f
Explicitly mention requirements.txt, to perform better in web searches
This is basically based on a wild guess, that the search engines would
rank this higher in searches about requirements.txt files, if we mention
the file explicitly here.
2021-09-08 08:45:29 +01:00
Pradyun Gedam 3c8462159b
Move "Requirements File Format" docs to reference/
This is a better, more visible location for this file format. It is more
discoverable and more likely to show up in search results.
2021-09-08 08:45:29 +01:00
Pradyun Gedam 2ae532ac19
Bring the reference/ section back
This was originally the reference to the command line interface for pip.
That is now handled by cli/ pages, which frees up these pages for
describing other aspects of pip.
2021-09-08 08:05:55 +01:00
Pradyun Gedam 354d92feea
Update Development Getting Started guide to reflect reality
- The VCS tests are automatically skipped. The phrasing in the guide
  stated otherwise.
- Recommend using `.venv` as the folder name for the virtual environment
  for development.
2021-09-08 07:49:26 +01:00
meowmeowcat d925e24836
Link to PyPUG instead of Setuptools 2021-09-05 12:24:08 +08:00
Pradyun Gedam b8fc219418
Merge pull request #10429 from jdufresne/pretend
Replace use of pretend library with unitest.mock in tests
2021-09-04 21:04:34 +01:00
Jon Dufresne 8f48b32581 Fix docs build failure
Resolves Sphinx error:

    .../pip/docs/html/user_guide.rst:1011:undefined label: dependency resolution backtracking
2021-09-04 11:08:45 -07:00
meowmeowcat 1f817dcdca Update a link of setuptools 2021-09-04 13:17:41 +08:00
meowmeowcat a4cb77ffd0
Update links of setuptools 2021-09-04 13:08:53 +08:00
Jon Dufresne 4a4103e173 Replace use of pretend library with unitest.mock in tests
The pretend library was used by very few tests. In all cases, it is
simple enough to switch to stdlib unitest.mock.

Using stdlib means there is one fewer library to install before running
tests. It can also simplify mypy usage via typeshed.
2021-09-03 16:23:28 -07:00
Jon Dufresne a775351a38 Clean up leftover references to removed Travis and Azure CI 2021-08-28 20:01:58 -07:00
meowmeowcat 544bdd13a4
Remove python -m
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
2021-08-26 14:29:47 +08:00
meowmeowcat 21abee685c
Add a section for upgrading pip 2021-08-26 13:57:16 +08:00
Pradyun Gedam 9cb23c9b4f
Merge pull request #10279 from pradyunsg/reorg-dependency-resolution-information 2021-08-15 22:18:51 +01:00
Stéphane Bidoul c1772d9d03
Remove pip list legacy format from documentation 2021-08-15 17:56:43 +02:00
Pradyun Gedam 53e2a5cf0a
Use pip-cli for an example pip invocation 2021-08-13 13:37:46 +01:00
Pradyun Gedam d7c33065ad
Move section on dependency conflicts to dependency resolution topic 2021-08-13 13:37:46 +01:00
Pradyun Gedam da6239de97
Move "reduce backtracking" to dependency resolution topic 2021-08-13 13:37:45 +01:00
Nipunn Koorapati 2aab462b7f Bump mypy to 0.910
This notably gets us on a version of mypy that uses modular typeshed:
https://mypy-lang.blogspot.com/2021/05/the-upcoming-switch-to-modular-typeshed.html
which allows us to have finer control over what version of stubs we pull
in from typeshed. Also contains other routine improvements to mypy.

Required a few minor typing changes.

Add flag --show-error-code so errors look like this

src/pip/_internal/network/auth.py:70: error: Incompatible types in assignment
(expression has type "None", variable has type Module)  [assignment]

rather than

src/pip/_internal/network/auth.py:70: error: Incompatible types in assignment
(expression has type "None", variable has type Module)
2021-08-09 16:47:02 -07:00
Tzu-ping Chung f0323c7888
Merge pull request #10200 from uranusjr/release-procedure-improvements 2021-08-07 17:58:43 +08:00
Tzu-ping Chung c18bc1661d
Merge pull request #10164 from pradyunsg/python-3.10 2021-08-07 10:42:16 +08:00
Pradyun Gedam 0d399df447
Fix a broken link 2021-08-06 14:06:43 +01:00
Pradyun Gedam 86188daa68
Add missing periods 2021-08-06 14:06:36 +01:00
Pradyun Gedam 3dc913a3e5
Remove no-longer-relevant page 2021-08-06 13:56:57 +01:00
Pradyun Gedam 4ee9a4af25
Add Python 3.10 support 2021-08-06 13:42:31 +01:00
Hugo van Kemenade 8e473886d6 Link directly to the new location to avoid an extra click and load 2021-08-04 12:16:03 +03:00
Paul Moore 2ea961ed3b Document the new resolver 2021-07-31 12:24:19 +01:00
Pradyun Gedam 086a85150d
Bump up to Sphinx 4
Using the newer versions of Sphinx enables using newer versions of the
Sphinx theme we use.
2021-07-28 10:49:25 +01:00
Pradyun Gedam 664beeabf7
Merge pull request #10197 from pradyunsg/breakout-tools-requirements-folder
Get rid of tools/requirements/ directory, by moving those files into better locations
2021-07-28 10:35:10 +01:00
Tzu-ping Chung 8e3c4bd3b9 Update major release process to use PR workflow
This works better for RMs without authority to push directly to main,
and helps prevent errors with the PR's CI checks.
2021-07-25 13:06:57 +08:00
johnthagen a8b8d4d7fe
Document how to install provides_extras from local wheel file (#9698) 2021-07-25 10:36:26 +08:00
Pradyun Gedam 25af8e5f36
Move docs requirements to docs/
This makes the file easier to locate, by placing it next to the stuff
that it will affect.
2021-07-24 12:06:51 +01:00
Pradyun Gedam d7c0e621e3
Merge branch 'main' into topic/dependency-resolution 2021-07-13 23:10:45 +01:00
Pradyun Gedam 14e48b5f28
Rephrase paragraph describing how dependency resolution works
- Clarify that pip is incrementally building up this information.
- Clarify that pip has to download files, which contain the dependency information.
- Hint at the fact that this is a recursive process.
2021-07-13 23:10:19 +01:00
Pradyun Gedam cc188ae0cb
Merge branch 'main' into topic/repeatable-installs 2021-07-13 22:58:28 +01:00
Pradyun Gedam 15459969b3
Merge pull request #10099 from pradyunsg/topic/vcs-support
Add topic guide: VCS Support
2021-07-12 07:55:13 +01:00
Pradyun Gedam 67da5a6b88
Fix a typo
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2021-07-11 09:27:26 +01:00
Pradyun Gedam c1295afdd5 Address review comments 2021-07-09 11:05:07 +01:00
Pradyun Gedam 414da9b029 Reword pip-starts-backtracking sentence
This reads clearer than the initial iteration.

Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-07-09 10:55:25 +01:00
Pradyun Gedam 520aed8b06
Stylise console output with console highlighting
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2021-07-02 12:18:53 +01:00
Pradyun Gedam 4fe94078d5 Update IRC links to libera.chat 2021-06-25 15:45:45 +01:00
Pradyun Gedam 97bab9f23f Add topic guide: Dependency Resolution 2021-06-25 13:08:03 +01:00
Pradyun Gedam b9d27d6d28 Add topic guide: Repeatable Installs 2021-06-25 11:58:02 +01:00
Pradyun Gedam 80285c686f Correctly look up os.devnull reference 2021-06-25 11:14:29 +01:00
Pradyun Gedam 9cd3d5d547 Drop old VCS support section and update links 2021-06-25 11:14:12 +01:00
Pradyun Gedam ad8a1b8da0 Add topic guide: VCS Support 2021-06-25 11:13:03 +01:00
Pradyun Gedam 0ab159a3f2 Add topic guide: Configuration 2021-06-11 16:26:24 +01:00
Pradyun Gedam 330cfa38e2 Enable definition lists in MyST
This is useful for presenting content.
2021-06-11 16:26:24 +01:00
Pradyun Gedam d63f06a881 Add a topic guide: Caching 2021-06-11 16:20:09 +01:00
Pradyun Gedam 9e1a92e3fe
Merge pull request #10024 from pradyunsg/remove-old-docs-pages
Remove old documentation pages
2021-06-11 13:40:04 +01:00
Pradyun Gedam de8882808b Fix typo in version added directive 2021-06-11 11:44:39 +01:00
Pradyun Gedam 9687f4598f Add an intersphinx link, to compatibility section
This was being used in a different part of our documentation.
2021-06-11 11:44:26 +01:00
Pradyun Gedam 5bc83d44a3 Fix typo in redirect to topics/authentication 2021-06-11 11:43:47 +01:00
Pradyun Gedam ad9d492989
Merge pull request #10023 from pradyunsg/show-is-for-local-packages
Move where show is shown in commands
2021-06-07 22:11:10 +01:00
Dirk Stolle b8e7a70fd5
Fix typos (#10001) 2021-06-03 16:44:42 +02:00
Pradyun Gedam 3930f5545f Add a topic guide for Authentication 2021-05-28 16:14:29 +01:00
Pradyun Gedam 7d42fb61ae Add a "Topic Guide" section to the documentation
This section will contain pages that describe a single topic (like
"Authentication", "Caching", etc).
2021-05-28 13:03:57 +01:00
Pradyun Gedam 70a2c723e8 Remove old documentation pages
These pages were redirecting users from really old versions of pip.
Breaking those links now should be fine, since these pages do not get
much traffic.
2021-05-28 12:43:31 +01:00
Pradyun Gedam b3a848af13 Move where show is shown in commands
It is for introspecting installed packages, not on the index.
2021-05-28 12:16:56 +01:00
Pradyun Gedam f9dc946e68
Use the footnote in the installation page 2021-05-22 12:13:41 +01:00
Pradyun Gedam 1b386366a3
installing.rst -> installation.md 2021-05-22 00:33:13 +01:00
Pradyun Gedam 34d181a5d6
quickstart.rst -> getting-started.md 2021-05-22 00:33:13 +01:00
Pradyun Gedam 5734d32546
Change first title in getting-started 2021-05-22 00:33:13 +01:00
Pradyun Gedam f99ccb15c3
Update copyright in conf.py, to match copyright.rst 2021-05-22 00:33:02 +01:00
Pradyun Gedam 0139009eb0
Flesh out the Getting Started page 2021-05-22 00:31:05 +01:00
Pradyun Gedam cbade4e657
Further tweak the installation page 2021-05-22 00:31:05 +01:00
Pradyun Gedam afcefa9088
Rewrite substantial portions of installation docs 2021-05-22 00:31:05 +01:00
Pradyun Gedam 86c79441e9
Add initial getting-started scaffold 2021-05-22 00:31:04 +01:00
Pradyun Gedam 9fb3b7c795
Add new installation document 2021-05-22 00:31:01 +01:00
Sviatoslav Sydorenko 92862e28ec
Enable parallelism in Sphinx 2021-04-20 22:35:53 +02:00
Stéphane Bidoul 8fc65ea53f
Merge pull request #9673 from mwchase/url-constraints-final-2
Support URL constraints in the new resolver
2021-04-18 12:31:45 +02:00
Max W Chase 4c69ab2a2c Support URL constraints in the new resolver
Fixes #8253
2021-04-17 07:59:57 -04:00
Tzu-ping Chung a912c5530d Rewrite collect_links
This introduces a collect_sources() method to do the same thing, but
instead of flattening links eagerly, return each repository entry
separately (and return a None for invalid repository options), so
subsequent code can better distinguish which link comes from which
repository.
2021-04-13 03:16:36 +08:00
Dominic Davis-Foster 4517306a6d
Remove third backtick from inline code block. 2021-04-11 21:49:25 +01:00
Stéphane Bidoul 29c50c8188 Add missing type annotation in docs/ 2021-04-04 13:58:59 +02:00
Tzu-ping Chung dee71ce661 Run lint on code base 2021-04-04 06:20:27 +08:00
Eric Cousineau f1f94baf5c try to encode more deets 2021-04-03 23:18:20 +08:00