summaryrefslogtreecommitdiff
path: root/docs/html/cli
Commit message (Collapse)AuthorAgeFilesLines
* Quote all install command components that aren't a bare package nameMatthew Feickert2023-03-141-24/+24
| | | | | | | | * As a means to make things easier for new users, quote everything in a `pip install` command that is part of a package that isn't just a bare package name. * Use single quotes for Linux/Mac and use double quotes for Windows to follow existing style conventions.
* Quote extras to guard shells with glob qualifiersMatthew Feickert2023-03-141-9/+9
| | | | | | | | | * Shells like zsh have glob qualifiers that will error if an extra is not quoted. While the glob qualifiers can be disabled, adding quotes guards against errors if people are copy-pasting or do not know that they can disable the behavior. * Use single quotes for Linux/Mac and use double quotes for Windows to follow existing style conventions.
* Update the macos tag in `pip download` docs (#11603)Rishi2022-11-161-3/+3
|
* Merge pull request #11254 from kasium/issue-11235Tzu-ping Chung2022-08-151-0/+8
|\
| * CommentsKai Mueller2022-08-031-0/+1
| |
| * Update docs/html/cli/pip_wheel.rstkasium2022-08-031-2/+2
| | | | | | Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
| * fix2Kai Mueller2022-07-191-1/+1
| |
| * fixKai Mueller2022-07-191-4/+2
| |
| * Clarify difference between pip-wheel and buildKai Mueller2022-07-131-0/+9
| | | | | | | | Closes #11235
* | Merge pull request #11322 from pradyunsg/docs/move-truststore-docsPradyun Gedam2022-08-051-11/+3
|\ \ | | | | | | Add a dedicated topic page for HTTPS certificates
| * | Add a dedicated topic page for HTTPS certificatesPradyun Gedam2022-07-291-11/+3
| | | | | | | | | | | | | | | | | | This makes further progress on moving content into dedeicated topic pages, away from dumping it into `pip install`'s documentation or as a part of the user guide.
* | | Add a clarifying note to the pip download docsPaul Moore2022-07-301-1/+3
|/ /
* | inspect: add versionadded to docsStéphane Bidoul2022-07-151-0/+1
| |
* | Add pip inspect commandStéphane Bidoul2022-07-152-0/+33
| |
* | install report: docsStéphane Bidoul2022-07-121-0/+12
|/
* fixed some spelling mistakesBastian Venthur2022-06-141-1/+1
| | | | that's all :)
* Change all moved headings to rubricsPradyun Gedam2022-06-103-36/+24
| | | | | This ensures that they don't show up in the table of contents sidebar, which is part of the point of moving this content into dedicated pages.
* Docs: Capitalise Y as the default for Proceed (#10969)Hugo van Kemenade2022-03-181-2/+2
| | | Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
* Fix a small typo in the docsDiego Ramirez2022-03-111-1/+1
| | | (a)abort (aabort?) -> (a)bort (abort)
* Add a dedicated topic page on "Secure Installs"Pradyun Gedam2022-02-181-156/+2
| | | | | This moves the content about hash checking mode into here, along with adding minor additional recommendation of using `--no-binary :all:`.
* Move section on per-requirement build system overridesPradyun Gedam2022-02-181-37/+1
| | | | | This also adds some prominent warnings to the section, to discourage users from using these options.
* Add a dedicated topic page for local project installationPradyun Gedam2022-02-181-63/+5
| | | | | | 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.
* Add a dedicated page for requirement specifiersPradyun Gedam2022-02-181-46/+1
| | | | This should make this information more discoverable.
* fix: spelling mistakes and typosYusuke Hayashi2022-02-171-1/+1
|
* Merge pull request #9674 from mobolic/document-that-overrides-disable-all-wheelsPradyun Gedam2022-01-311-2/+5
|\
| * Document that using overrides disables all wheelsMartey Dodoo2022-01-051-2/+5
| | | | | | | | | | | | 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.
* | Merge pull request #10484 from pradyunsg/updated-direct-references-versionPradyun Gedam2021-12-041-1/+1
|\ \
| * | Update when "direct references" got supported, to reflect realityPradyun Gedam2021-09-181-1/+1
| | |
* | | Drop "setuptools" qualifier and link to PEP page for extraslayday2021-11-051-2/+2
| | | | | | | | | | | | Extras are not specific to setuptools anymore.
* | | Merge pull request #10495 from sbidoul/out-of-tree-build-flagPradyun Gedam2021-10-021-12/+14
|\ \ \
| * | | Make in-tree-build the defaultStéphane Bidoul2021-09-251-12/+14
| | |/ | |/| | | | | | | Add an out-of-tree-build feature flag to ease the transition.
* | | Add a dedicated "Build system interface" reference sectionPradyun Gedam2021-09-283-297/+7
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Improve docsStéphane Bidoul2021-09-211-3/+3
| | | | | | Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
* | Add docs example for pip list and editable installsStéphane Bidoul2021-09-211-0/+90
|/
* Merge pull request #10450 from pradyunsg/docs/requirements-formatPradyun Gedam2021-09-171-111/+1
|\ | | | | Add a dedicated page for "Requirements File Format"
| * Move "Requirements File Format" docs to `reference/`Pradyun Gedam2021-09-081-111/+1
| | | | | | | | | | This is a better, more visible location for this file format. It is more discoverable and more likely to show up in search results.
* | Link to PyPUG instead of Setuptoolsmeowmeowcat2021-09-051-1/+1
| |
* | Update links of setuptoolsmeowmeowcat2021-09-041-4/+4
|/
* Remove pip list legacy format from documentationStéphane Bidoul2021-08-151-70/+10
|
* Fix a broken linkPradyun Gedam2021-08-061-1/+1
|
* Add missing periodsPradyun Gedam2021-08-061-2/+2
|
* Link directly to the new location to avoid an extra click and loadHugo van Kemenade2021-08-041-1/+1
|
* Merge branch 'main' into topic/repeatable-installsPradyun Gedam2021-07-131-165/+4
|\
| * Drop old VCS support section and update linksPradyun Gedam2021-06-251-165/+4
| |
* | Add topic guide: Repeatable InstallsPradyun Gedam2021-06-251-3/+3
|/
* Add a topic guide: CachingPradyun Gedam2021-06-111-50/+2
|
* Move where show is shown in commandsPradyun Gedam2021-05-281-1/+1
| | | | It is for introspecting installed packages, not on the index.
* address review, I think?Eric Cousineau2021-04-031-3/+5
|
* docs: Describe --upgrade-strategy and direct requirements explicitlyEric Cousineau2021-04-031-0/+5
| | | | Add a brief example
* Merge branch 'main' into dependency-confustion-documentationTzu-ping Chung2021-04-031-10/+19
|