McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

docs: use autonumbered examples in docs

This commit is contained in:
Xavier Fernandez 2016-05-16 21:33:51 +02:00
parent 6dcd9dac2e
commit 1d2abae9a1
8 changed files with 114 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/pip_download.rst
View File

@ -42,12 +42,10 @@ Options
Examples
********
1. Download a package and all of its dependencies
#. Download a package and all of its dependencies
::
$ pip download SomePackage
$ pip download -d . SomePackage # equivalent to above
$ pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage

4
docs/reference/pip_freeze.rst
View File

@ -27,7 +27,7 @@ Options
Examples
********
1) Generate output suitable for a requirements file.
#. Generate output suitable for a requirements file.
::
@ -39,7 +39,7 @@ Examples
Sphinx==1.2.2
2) Generate a requirements file and then install from it in another environment.
#. Generate a requirements file and then install from it in another environment.
::

18
docs/reference/pip_install.rst
View File

@ -742,7 +742,7 @@ Options
Examples
********
1) Install `SomePackage` and its dependencies from `PyPI`_ using :ref:`Requirement Specifiers`
#. Install `SomePackage` and its dependencies from `PyPI`_ using :ref:`Requirement Specifiers`
::
@ -751,21 +751,21 @@ Examples
$ pip install 'SomePackage>=1.0.4' # minimum version
2) Install a list of requirements specified in a file. See the :ref:`Requirements files <Requirements Files>`.
#. Install a list of requirements specified in a file. See the :ref:`Requirements files <Requirements Files>`.
::
$ pip install -r requirements.txt
3) Upgrade an already installed `SomePackage` to the latest from PyPI.
#. Upgrade an already installed `SomePackage` to the latest from PyPI.
::
$ pip install --upgrade SomePackage
4) Install a local project in "editable" mode. See the section on :ref:`Editable Installs <editable-installs>`.
#. Install a local project in "editable" mode. See the section on :ref:`Editable Installs <editable-installs>`.
::
@ -773,7 +773,7 @@ Examples
$ pip install -e path/to/project # project in another directory
5) Install a project from VCS in "editable" mode. See the sections on :ref:`VCS Support <VCS Support>` and :ref:`Editable Installs <editable-installs>`.
#. Install a project from VCS in "editable" mode. See the sections on :ref:`VCS Support <VCS Support>` and :ref:`Editable Installs <editable-installs>`.
::
@ -783,7 +783,7 @@ Examples
$ pip install -e git+https://git.repo/some_pkg.git@feature#egg=SomePackage # from 'feature' branch
$ pip install -e "git+https://git.repo/some_repo.git#egg=subdir&subdirectory=subdir_path" # install a python package from a repo subdirectory
6) Install a package with `setuptools extras`_.
#. Install a package with `setuptools extras`_.
::
@ -792,7 +792,7 @@ Examples
$ pip install -e .[PDF]==3.0 # editable project in current directory
7) Install a particular source archive file.
#. Install a particular source archive file.
::
@ -800,7 +800,7 @@ Examples
$ pip install http://my.package.repo/SomePackage-1.0.4.zip
8) Install from alternative package repositories.
#. Install from alternative package repositories.
Install from a different index, and not `PyPI`_ ::
@ -817,7 +817,7 @@ Examples
$ pip install --no-index --find-links=relative/dir/ SomePackage
9) Find pre-release and development versions, in addition to stable versions. By default, pip only finds stable versions.
#. Find pre-release and development versions, in addition to stable versions. By default, pip only finds stable versions.
::

10
docs/reference/pip_list.rst
View File

@ -26,7 +26,7 @@ Options
Examples
********
1) List installed packages.
#. List installed packages.
::
@ -37,7 +37,7 @@ Examples
Pygments (1.6)
Sphinx (1.2.1)
2) List outdated packages (excluding editables), and the latest version available
#. List outdated packages (excluding editables), and the latest version available.
::
@ -45,7 +45,7 @@ Examples
docutils (Current: 0.10 Latest: 0.11)
Sphinx (Current: 1.2.1 Latest: 1.2.2)
3) List installed packages with column formatting.
#. List installed packages with column formatting.
::
@ -56,7 +56,7 @@ Examples
idlex 1.13
jedi 0.9.0
4) List outdated packages with column formatting.
#. List outdated packages with column formatting.
::
@ -66,7 +66,7 @@ Examples
retry 0.8.1 0.9.1 wheel
setuptools 20.6.7 21.0.0 wheel
5) Do not use column formatting.
#. Do not use column formatting.
::

2
docs/reference/pip_search.rst
View File

@ -25,7 +25,7 @@ Options
Examples
********
1. Search for "peppercorn"
#. Search for "peppercorn"
::

2
docs/reference/pip_show.rst
View File

@ -25,7 +25,7 @@ Options
Examples
********
1. Show information about a package:
#. Show information about a package:
::

2
docs/reference/pip_uninstall.rst
View File

@ -24,7 +24,7 @@ Options
Examples
********
1) Uninstall a package.
#. Uninstall a package.
::

4
docs/reference/pip_wheel.rst
View File

@ -65,11 +65,9 @@ Options
Examples
********
1. Build wheels for a requirement (and all its dependencies), and then install
#. Build wheels for a requirement (and all its dependencies), and then install
::
$ pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
$ pip install --no-index --find-links=/tmp/wheelhouse SomePackage