Commit Graph

64 Commits

Author SHA1 Message Date
Pradyun Gedam fb03b6aede
Switch to sphinx-inline-tabs for tabs 2020-10-18 22:42:24 +05:30
shireenrao 8f3151324f fix inconsistent indentation of tab blocks 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati a2e2f5d052 update all tabs with command output be console code-blocks 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 28a00633d8 Remove platform prompt when not output is displayed 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati 423ccfd4f1 WIP upd directive to use cmd prefix + upd ref docs 2020-09-13 20:59:29 -04:00
Srinivas Nyayapati da3b7e0578 WIP - update pip-command-usage to take optional arguments and update pip install docs 2020-09-13 20:59:29 -04:00
Emmanuel Arias 65bddac52f
Update Caching documentation
Any headers from serve are ignored. So, this PR remove
the paragraph that mention that. See #8009 and #5670

Close #8009
2020-09-07 10:50:03 -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
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
Noah Gorny a80d5426ca docs: Reqfile options are now generated automatically 2020-06-01 21:56:59 +03:00
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
Pradyun Gedam 45f762eb7b
Merge pull request #7780 from AndydeCleyre/bugfix/7728 2020-04-27 12:51:54 +05:30
Pradyun Gedam 756b02f712
Improve documentation for in-place builds 2020-04-20 02:23:22 +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
Stéphane Bidoul 88e6e6bc5c
build in place 2020-04-12 12:00:57 +02: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 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
John T. Wodder II c42b5d3716 Change docs link from PEP 301 to PEP 503 2020-03-25 23:57:18 -04:00
Andy Kluger 42814f0124 Fix docs: comment stripping comes _after_ line continuation processing 2020-02-24 15:28:16 -05:00
Pradyun Gedam e648e00dc0
pip is spelt all-lowercase 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
Stéphane Bidoul (ACSONE) cf071dee55
Deprecate git+git@ form of VCS url 2020-01-02 19:20:29 +01: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
Swat009 844fcc1cc5 Updated info about pip support for url_req portion of PEP508 (#6768) 2019-11-18 09:45:35 +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
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
Jiashuo Li 530c1d7344
Add double quotes to pip install from VCS 2019-11-12 10:32:21 +08:00
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
Ananya Maiti bb047aa263 Document that "coding: utf-8" is supported in requirements.txt
Fixes #7182
2019-10-31 20:27:00 +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
Pradyun Gedam c47e1b6e5d
Enable rst-backticks for ReST files and NEWS fragments 2019-09-24 18:03:22 +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
Vinicyus Macedo 16af35c613 Adding improvements to the _get_path_to_url function 2019-08-12 14:32:03 -03:00
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