Commit Graph

84 Commits

Author SHA1 Message Date
Oz N Tiram ce83c62938 Merge branch 'main' into master 2022-02-10 11:17:28 +01:00
Thomas Sorrel 1d8f08100b doc fix docker container title 2022-02-09 18:04:02 +01:00
Oz N Tiram e6b15166f5 Fix typo in docker documnetation
This is now the correct path for running the application code.
2022-01-23 21:08:17 +01:00
Sardorbek Imomaliev e9fa01620d Fix typo in docs/basics.rst for docker example 2022-01-13 14:17:34 +07:00
Oz N Tiram fa0452f7cc Document usage of Pipenv in multistage docker build
Also, add a note about running Pipenv as root (or Admin)
with a bold warning.
2022-01-11 22:43:32 +01:00
Oz N Tiram 1448251e21 Add note about running pipenv as root
Also, document how to use pipenv in containers.

Issue #3130.
2022-01-10 14:05:52 +01:00
danawaze 6e4f4103fb Fix basic usage docs to reflect lock -r behaviour
The pre-existing basic usage documentation says that "pipenv lock -r" would include hashes in requirements.txt, this is not the behaviour i observe - i didn't find any issue around this - i guess it's either a bug or just the documentation is wrong.

Digging through the code it looks reasonably plain that it just does not include hashes in its output - there is no logic or option there:

https://github.com/pypa/pipenv/blob/master/pipenv/core.py#L849
2021-06-08 19:26:17 +01:00
David Beitey a989001a0e Add #egg fragment to URL in VCS docs 2021-05-10 00:31:17 +00:00
Deepyaman Datta 4144092e5b Fix description of the compatible-release operator 2020-12-14 23:15:57 -05:00
Ashwin Ramaswami 71f4b3010e Clarify that python_version can be in the format "X"
For example, it can be equal to "3".
2020-07-25 10:31:55 -04:00
jerojasro 174a667834 Update basics.rst 2020-04-04 17:26:34 -05:00
jerojasro 91cd4235fb Update basics.rst 2020-04-04 17:25:25 -05:00
jerojasro ddd4b3e7e7 minor redaction fix 2020-04-03 15:59:20 -05:00
Eric Hanchrow 940a693b46 Improve wording in "basics.rst" 2020-01-17 20:00:02 -08:00
Tapasweni Pathak 5b6bfc96b5 Merge branch 'master' into ticket-3383 2019-10-16 16:55:06 +05:30
Tapasweni Pathak 3bd4e893ac address review 2019-10-16 05:59:20 +05:30
Tapasweni Pathak 372c3789aa Merge branch 'master' into ticket-3383 2019-10-14 16:42:02 +03:00
Tapasweni Pathak 39cb07d625 Merge branch 'master' into ticket-2318 2019-10-14 16:41:56 +03:00
Jon Erling Hustadnes 9b6a745758 Fixed link references for PEP 440 2019-10-05 15:37:41 +02:00
Tapasweni Pathak 823f71fcce address review 2019-09-25 21:32:50 +05:30
Tapasweni Pathak 76c49a3f45 Merge branch 'master' into ticket-2318 2019-09-25 21:31:32 +05:30
Tapasweni Pathak 0b1108aa40 Merge branch 'master' into ticket-3383 2019-09-25 21:25:27 +05:30
Tapasweni Pathak 7a12dbb5ca Doc: Write pipefile description (#3937)
Doc: Write pipefile description
2019-09-10 11:21:00 +08:00
Tapasweni Pathak a108625ad9 Remove extension differences text 2019-09-09 06:38:00 +05:30
Tapasweni Pathak b90fb1b9ba Clearly define python_version format info 2019-09-08 22:07:24 +05:30
Tapasweni Pathak 4b21f5a289 Remove --system 2019-09-08 21:53:41 +05:30
Tapasweni Pathak b0a683926e Doc: Documentation for --deploy extension and few extension differences 2019-09-07 23:33:23 +05:30
Tapasweni Pathak 589eead7bc Doc: Add python_version value 2019-09-07 22:37:03 +05:30
Štěpán Tomsa 0acafd84d2 Remove misleading code comment from docs
In the Specifying Versions section of the Basics documentation, there is
a misleading code comment saying that requests~=1.2 is equivalent to
requests~=1.2.0, which it isn’t. ~=1.2 is equivalent to >=1.2,<2.0, but
~=1.2.0 is equivalent to >=1.2.0,<1.3. Fixed by removing the comment.
2019-08-05 18:13:19 +02:00
Frost Ming 2f619df5f9 Merge branch master 2019-07-14 15:36:41 +08:00
Nicholas Surmava 2248222c14 added the TOML Spec link to the documentation 2019-03-23 13:45:24 -05:00
Frost Ming 546e3ac1d8 Merge branch 'master' into patch-2 2019-03-08 14:59:55 +08:00
Daniel Phillips f22a564a2b Fix pip specifier documentation mistake where 'former' was incorrectly used instead of 'latter' (#3507) 2019-03-07 17:35:59 +08:00
David Beitey 4514c0cab3 Docs: clarify quoting in version specs note
Previously it was confusing as to what `" "` meant exactly -- I read it
as a whitespace character was needed somewhere when it's referring to
the double quote characters.
2019-02-11 17:14:49 +10:00
Frost Ming 12b66e1e4a update manual
Signed-off-by: Frost Ming <mianghong@gmail.com>
2018-11-18 09:23:37 +08:00
Peter Schutt a84f5443af Incorrect ref in VCS example
Small changes, but a couple of issues in the `A Note About VCS Dependencies` section of the docs.

Running the example `$ pipenv install -e git+https://github.com/requests/requests.git@v2.19#egg=requests` raises the error: `Did not find branch or tag 'v2.19', assuming revision or ref.` I think it should be 'v2.19.1' which is just a typo as 'v2.19.1' is used in the subsequent lines of the example.

The example Pipfile in the  section excludes the `v` in the version number written to the `ref = ` part. I found it a little confusing that it would strip the 'v' from the tag, but then on testing it I found that it doesn't do that:

```
[packages]
requests = {editable = true, ref = "v2.20.1", git = "https://github.com/requests/requests.git"}
```

Also, while I was here I figured I'd update the example to the most recent requests release.

Thanks.
2018-11-15 10:17:58 +11:00
Guillermo Guirao Aguilar 38fe342f13 Fix typo 2018-10-19 15:42:30 +02:00
Tania Allard 87551b9d45 Documentation: how to use pip specifiers with Pipenv
Fix #2930.
2018-10-18 00:20:47 +08:00
Aditya Srivastava 4588ffebda Added shell deactivation instruction to documentation
Minor edits to documentation
2018-10-07 09:24:25 +05:30
Gabi Nagy 51c3c8b600 Fix pipenv install --dev description
By default, `pipenv install` will install packages
based on the list in `Pipfile`, not `Pipfile.lock`.
`pipenv install --dev` is no exception.

I've tested this using pipenv 2018.7.1
with different package versions in `Pipfile`
and `Pipfile.lock`. After `pipenv install`,
the versions in `Pipfile` were the ones
actually installed.
2018-09-14 11:23:03 +08:00
Tzu-ping Chung 505d093ab3 Merge branch 'master' into reinout-fixed-missing-egg-in-url 2018-08-30 12:15:30 +08:00
Griffin Myers e5462303d2 Fix typo in basics.rst
organizatoin => organization
2018-08-29 15:35:50 -04:00
Reinout van Rees 7f1bd507ae Added missing 'egg=' in the example url 2018-08-29 15:13:23 +02:00
Dan Ryan a4ad13e52b Update readme images, port readme add news
Signed-off-by: Dan Ryan <dan@danryan.co>
2018-08-17 16:34:28 -04:00
零件 c91cce1233 Merge branch 'master' into master 2018-08-07 09:34:21 +08:00
零件 c6742a8430 Minor tense changes with basics.rst 2018-08-07 09:33:21 +08:00
Dan Ryan 4bfa219985 Use proper syntax for rst links
Fix link syntax for pep440 links in documentation
2018-08-04 18:16:35 -04:00
零件 81a189dbc5 Update basics.rst
Update link with Sphinx’s reference syntax.
2018-08-02 16:31:58 +08:00
零件 0f30bcbcdb Update basics.rst
Add the description of `PIPENV_SHELL`
2018-08-01 22:34:33 +08:00
Michael 587125c279 Fix syntax of link 2018-07-30 14:38:53 +10:00