Commit Graph

33 Commits

Author SHA1 Message Date
Qiming Xu 28250baffb
Fix line wrap length and add news entry 2023-11-28 14:17:51 +08:00
Qiming Xu 88ac529219
Fix outdated pip install argument description 2023-11-28 13:15:31 +08:00
Matthew Feickert ced45695a0 Quote all install command components that aren't a bare package name
* 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.
2023-03-14 00:22:15 -05:00
Matthew Feickert 9a82bdfc52 Quote extras to guard shells with glob qualifiers
* 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.
2023-03-14 00:22:15 -05:00
Pradyun Gedam dc1ea04e92 Add a dedicated topic page for HTTPS certificates
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.
2022-07-29 13:03:47 +01:00
Stéphane Bidoul 0198eae492
install report: docs 2022-07-12 18:51:36 +02:00
Pradyun Gedam 347e724efe Change all moved headings to rubrics
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.
2022-06-10 11:29:02 +01: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 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 193259d3dc
Merge pull request #9674 from mobolic/document-that-overrides-disable-all-wheels 2022-01-31 07:50:35 +00:00
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
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 a07bfb33a0
Merge pull request #10495 from sbidoul/out-of-tree-build-flag 2021-10-02 12:34:24 +01: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
Pradyun Gedam 01279bdb02
Update when "direct references" got supported, to reflect reality 2021-09-18 09:46: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 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
meowmeowcat d925e24836
Link to PyPUG instead of Setuptools 2021-09-05 12:24:08 +08:00
meowmeowcat a4cb77ffd0
Update links of setuptools 2021-09-04 13:08:53 +08:00
Pradyun Gedam 86188daa68
Add missing periods 2021-08-06 14:06:36 +01:00
Pradyun Gedam cc188ae0cb
Merge branch 'main' into topic/repeatable-installs 2021-07-13 22:58:28 +01:00
Pradyun Gedam b9d27d6d28 Add topic guide: Repeatable Installs 2021-06-25 11:58:02 +01:00
Pradyun Gedam 9cd3d5d547 Drop old VCS support section and update links 2021-06-25 11:14:12 +01:00
Pradyun Gedam d63f06a881 Add a topic guide: Caching 2021-06-11 16:20:09 +01:00
Eric Cousineau 9f73611df6 address review, I think? 2021-04-03 23:18:19 +08:00
Eric Cousineau b43a8ed51e docs: Describe --upgrade-strategy and direct requirements explicitly
Add a brief example
2021-04-03 23:18:19 +08:00
Tzu-ping Chung 5df7d26a4e Merge branch 'main' into dependency-confustion-documentation 2021-04-03 16:50:16 +08:00
Tzu-ping Chung b3fd603b22 Merge branch 'main' into patch-1 2021-04-03 16:11:00 +08:00
Pradyun Gedam 0147cd1e29
Move /reference/ to /cli/ 2021-04-02 11:10:17 +01:00
Renamed from docs/html/reference/pip_install.rst (Browse further)