Pradyun Gedam
23324a664f
Merge pull request #9131 from uranusjr/install-method-order
2020-11-14 04:06:17 +05:30
Tzu-ping Chung
657d91f672
Reorder and revise installation docs
...
An additional section is added to instruct the user to self-check
whether pip is installed before proceeding.
The Linux package manager section is moved to the front to encourage
users to try that first before learning about get-pip.py, which tends to
provide seemingly working but subtly broken results there. A paragraph
is added to the section to instruct users to report issues to package
managers instead.
A new section on enturepip is added as an alternative to get-pip.py,
which is almost guarenteed to be available at this point.
2020-11-14 05:37:03 +08:00
Pradyun Gedam
321163fb98
Fix misplaced blockquotes
...
Signed-off-by: Pradyun Gedam <pradyunsg@users.noreply.github.com>
2020-11-12 07:29:19 +05:30
Pradyun Gedam
6962284236
Remove inline table of contents
...
Furo provides a fully-fleshed-out right sidebar that provides an in-page
table of contents, that's scrollable and does not interrupt content.
2020-11-12 07:29:19 +05:30
Pradyun Gedam
f3ee03d6d0
Drop custom styling for admonitions
2020-11-12 07:29:19 +05:30
Pradyun Gedam
19717d1701
Switch documentation theme to Furo
2020-11-12 07:29:19 +05:30
Pradyun Gedam
5bfc0259f9
Clarify which version of pip we're seeing
2020-11-12 07:29:18 +05:30
Sumana Harihareswara
3f4e15aef0
docs: Emphasize that pip may break existing packages
...
Related to #7744 .
2020-10-29 13:51:29 -04:00
Sumana Harihareswara
fbcdeca91a
Clarify constraints overhaul in user guide
...
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
395e1ae8e8
Add detail to docs on constraints changes with new resolver
...
Related to #8307 , #8115 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
27b100e8d1
Explain resolver changes affecting constraints files
...
Related to #8792 , #8076 , #9020 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
5393032025
Improve docs on resolver, constraints, and hash-checking
...
Related to #9020 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
b7c3503a34
Add note about install/upgrade behavior to docs
...
Towards #8115 .
2020-10-29 13:49:08 -04:00
Sumana Harihareswara
7657c44409
docs: Clarify links for resolver work and studies
...
Co-Authored-By: Bernard Tyers <bernard+work@ei8fdb.org>
2020-10-28 23:29:09 -04:00
Sumana Harihareswara
4ce9565aa1
Update docs about Python 2 and resolver
...
Per #9019 .
2020-10-28 23:22:17 -04:00
Sumana Harihareswara
f4e96e95c9
Add redirect for heading in user guide
2020-10-28 23:22:17 -04:00
Sumana Harihareswara
3a20399d93
Update user guide to change resolver default
...
In pip 20.3, the new resolver will be the default.
Therefore, this commit updates user docs to change
instructions for testing, migration, etc.
Towards #8937 .
2020-10-28 23:22:17 -04:00
Xavier Fernandez
1cd89f824a
Fix trivial news file generation on windows
2020-10-28 23:55:13 +01:00
Daniel Katz
cea9f32dae
Support multiple abi
and platform
values for pip download
.
2020-10-27 19:00:22 -04:00
Xavier Fernandez
c15f8672ec
Merge pull request #8972 from drpoggi/patch-1
...
Fix docs for trusted-host in config file
2020-10-26 23:58:47 +01:00
279e735969
Update docs for less common news extension
...
Namely trivial, vendor and process. These were missed
during the trasition to *.rst news fragment.
2020-10-19 22:37:10 +07:00
Pradyun Gedam
fb03b6aede
Switch to sphinx-inline-tabs for tabs
2020-10-18 22:42:24 +05:30
David Poggi
e48234e669
Fix docs for trusted-host in config file
2020-10-08 11:43:08 -04:00
Pradyun Gedam
a0f2f2cd5f
Merge pull request #8942 from brainwane/docs-8661
...
docs: Add how to default to new resolver
2020-10-06 18:56:56 +05:30
Pradyun Gedam
603b2fa4ca
Rework the NEWS entries section
2020-10-03 16:48:56 +05:30
Sumana Harihareswara
3b44d70b5e
docs: Add how to default to new resolver
...
Fixes #8661 .
2020-09-30 07:12:10 -04:00
Pradyun Gedam
fe2075b686
Merge pull request #8848 from webknjaz/features/8783--sphinx-ext-admonitions
2020-09-30 11:00:43 +05:30
Sumana Harihareswara
6138184e2c
Update docs index page about resolver and UX work
2020-09-28 15:23:55 -04:00
Hugo van Kemenade
d4686b5793
Document Python support policy
2020-09-27 21:11:35 +03:00
Sviatoslav Sydorenko
13962cd6ad
🎨 Colorize the "important" admonition blocks
2020-09-25 23:25:36 +02:00
Sviatoslav Sydorenko
3301284810
📝 Add initial sphinx ext for per-doc feedbacks
...
Resolves #8783
2020-09-25 23:25:35 +02:00
Pradyun Gedam
75befb5a44
Merge pull request #8589 from shireenrao/upd-pip-docs
2020-09-24 21:43:38 +05:30
Pradyun Gedam
955daa940a
Merge pull request #7859 from pradyunsg/docs/deep-dive-cli
...
Architecture Documentation: CLI deep dive
2020-09-24 02:00:24 +05:30
Pradyun Gedam
89dad17b87
Update linter: pygrep-hooks
2020-09-23 19:52:20 +05:30
Pradyun Gedam
e408f7077f
Merge pull request #8873 from hugovk/docs-3-months-deprecation
2020-09-21 02:26:17 +05:30
Hugo van Kemenade
294995bc47
Fix typo
2020-09-14 23:00:48 +03:00
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
c36bd748f3
fix tox.ini and conf.py to use sphinx_tabs_nowarn
2020-09-13 20:59:29 -04:00
Srinivas Nyayapati
7673712d3e
Add tabs to get-pip.py install page
2020-09-13 20:59:29 -04:00
Srinivas Nyayapati
4a6276bfc9
Add tabs to ref docs
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
Srinivas Nyayapati
bcd0450158
WIP - update getting-started and pip ref docs
2020-09-13 20:59:29 -04:00
Srinivas Nyayapati
55c06d181b
WIP - use code-block within group-tab for consistent look
2020-09-13 20:59:29 -04:00
Srinivas Nyayapati
f1abd651e3
WIP change user guide + make consistent changes across
2020-09-13 20:59:28 -04:00
Srinivas Nyayapati
ad8cc27b8c
update quickstart.rst to use tabs
2020-09-13 20:47:16 -04:00
Srinivas Nyayapati
28f3f2cd2c
ignore sphinx-tab extension for man builds
2020-09-13 20:47:16 -04:00
Srinivas Nyayapati
119d8666b4
implement sphinx-tabs on installing page of docs
2020-09-13 20:47:16 -04:00