Skip to content

Commit 9423fd3

Browse files
committed
Add docs for pip index
1 parent ab2c978 commit 9423fd3

File tree

4 files changed

+68
-2
lines changed

4 files changed

+68
-2
lines changed

docs/html/cli/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ pip_hash
3737
:caption: Package Index information
3838
3939
pip_search
40+
pip_index
4041
```
4142

4243
```{toctree}

docs/html/cli/pip_index.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _`pip index`:
2+
3+
===========
4+
pip index
5+
===========
6+
7+
8+
9+
Usage
10+
=====
11+
12+
.. tab:: Unix/macOS
13+
14+
.. pip-command-usage:: index "python -m pip"
15+
16+
.. tab:: Windows
17+
18+
.. pip-command-usage:: index "py -m pip"
19+
20+
21+
Description
22+
===========
23+
24+
.. pip-command-description:: index
25+
26+
27+
28+
Options
29+
=======
30+
31+
.. pip-command-options:: index
32+
33+
34+
35+
Examples
36+
========
37+
38+
#. Search for "peppercorn" versions
39+
40+
.. tab:: Unix/macOS
41+
42+
.. code-block:: console
43+
44+
$ python -m pip index versions peppercorn
45+
peppercorn (0.6)
46+
Available versions: 0.6, 0.5, 0.4, 0.3, 0.2, 0.1
47+
48+
49+
.. tab:: Windows
50+
51+
.. code-block:: console
52+
53+
C:\> py -m pip index peppercorn
54+
peppercorn (0.6)
55+
Available versions: 0.6, 0.5, 0.4, 0.3, 0.2, 0.1

docs/html/reference/pip_index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:orphan:
2+
3+
.. meta::
4+
5+
:http-equiv=refresh: 3; url=../../cli/pip_index/
6+
7+
This page has moved
8+
===================
9+
10+
You should be redirected automatically in 3 seconds. If that didn't
11+
work, here's a link: :doc:`../cli/pip_index`

news/13188.feature.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
Remove `experimental` warning from `pip index versions` command and
2-
add json output support.
1+
Remove ``experimental`` warning from ``pip index versions`` command.

0 commit comments

Comments
 (0)