From 773fcb519de921239ae6f16f2b427e5c767d5573 Mon Sep 17 00:00:00 2001 From: Dave Schaefer Date: Sun, 8 Oct 2023 10:32:24 -0600 Subject: [PATCH] Add docs for `[pipenv]` directives Based on notes from existing code and release docs Note that `keep_outdated` has been discontinued, so no docs added for it. --- docs/pipfile.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/pipfile.md b/docs/pipfile.md index fa4e4d41..a260fa9d 100644 --- a/docs/pipfile.md +++ b/docs/pipfile.md @@ -10,6 +10,15 @@ This file is managed automatically through locking actions. You should add both `Pipfile` and `Pipfile.lock` to the project's source control. +## `[pipenv]` Directives + +`Pipfile` may contain a `[pipenv]` section to control the behaviour of pipenv itself. Some available settings include: + +* `allow_prereleases` - Tell pipenv to install pre-release versions of a package -i.e. a version with an alpha/beta/etc. suffix, such as _1.0b1_. Equivalent to passing the `--pre` flag on the command line. +* `disable_pip_input` - Prevent pipenv from asking for input. Equivalent to the `--no-input` flag. +* `install_search_all_sources` - Allow installation of packages from an existing `Pipfile.lock` to search all defined indexes for the constrained package version and hash signatures. See [Specifying Package Indexes](indexes.md). + + ## Example Pipfile Here is a simple example of a `Pipfile` and the resulting `Pipfile.lock`.