From 8a3af1b01239b0f7d033339f417f65c2aa8c392a Mon Sep 17 00:00:00 2001 From: Matthew Clapp Date: Thu, 5 Dec 2019 23:05:15 -0800 Subject: [PATCH] Rebuild docs. --- README.md | 2 +- docs/docs.md | 25 ++++++++++--------------- docs/index.md | 2 +- 3 files changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1355ca2a53..0e4ac47701 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ See Contributing for how to update this file. - + Code style: black

diff --git a/docs/docs.md b/docs/docs.md index daad583b68..d9955c34ec 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -36,8 +36,7 @@ subcommands: for each package. uninstall Uninstall a package uninstall-all Uninstall all packages - reinstall-all Reinstall all packages with a different Python - executable + reinstall-all Reinstall all packages list List installed packages run Download the latest version of a package to a temporary virtual environment, then run an app from @@ -169,9 +168,9 @@ optional arguments: ``` pipx upgrade --help -usage: pipx upgrade [-h] [--spec SPEC] [--force] [--include-deps] - [--system-site-packages] [--index-url INDEX_URL] - [--editable] [--pip-args PIP_ARGS] [--verbose] +usage: pipx upgrade [-h] [--force] [--system-site-packages] + [--index-url INDEX_URL] [--editable] [--pip-args PIP_ARGS] + [--verbose] package Upgrade a package in a pipx-managed Virtual Environment by running 'pip @@ -182,13 +181,8 @@ positional arguments: optional arguments: -h, --help show this help message and exit - --spec SPEC The package name or specific installation source - passed to pip. Runs `pip install -U SPEC`. For example - `--spec mypackage==2.0.0` or `--spec - git+https://github.com/user/repo.git@branch` --force, -f Modify existing virtual environment and files in PIPX_BIN_DIR - --include-deps Include apps of dependent packages --system-site-packages Give the virtual environment access to the system site-packages dir. @@ -295,20 +289,21 @@ optional arguments: ``` pipx reinstall-all --help -usage: pipx reinstall-all [-h] [--skip SKIP [SKIP ...]] [--verbose] python +usage: pipx reinstall-all [-h] [--python PYTHON] [--skip SKIP [SKIP ...]] + [--verbose] -Reinstalls all packages using a different version of Python. +Reinstalls all packages. Packages are uninstalled, then installed with pipx install PACKAGE with the same options used in the original install of PACKAGE. This is useful if you upgraded to a new version of Python and want all your packages to use the latest as well. -positional arguments: - python - optional arguments: -h, --help show this help message and exit + --python PYTHON The Python executable used to recreate the Virtual + Environment and run the associated app/apps. Must be + v3.5+. --skip SKIP [SKIP ...] skip these packages --verbose diff --git a/docs/index.md b/docs/index.md index 1355ca2a53..0e4ac47701 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ See Contributing for how to update this file. - + Code style: black