Commit Graph

551 Commits

Author SHA1 Message Date
Matt Davis c1924dbf44 Remvoe reference to -r from documentation. (#5258) 2022-08-14 23:43:36 -04:00
otherjake ec38ae1e81 Add unit test, create a section about venv names
in advanced docs.
2022-08-04 10:56:48 +02:00
otherjake badc1f4fa9 Support PIPENV_CUSTOM_VENV_NAME from environments
in the same way as other environment variables.
Update documentation to include the new variable.
2022-08-04 10:56:48 +02:00
Oz N Tiram 37db0234df Add some documentation on how to run tests locally. 2022-07-27 06:52:30 +02:00
Matt Davis 0ee8234890 Issue 5000 remove requests certifi (#5146)
* Depend on requests and certifi from vendored pip and remove it as explicit vendor dependency.

* Documentation tweak.

* Add a news fragment.

* Update remaining vendor dependencies to point at the pip requests.

* vendoring task needs requests.
2022-06-27 21:13:30 +02:00
Oz N Tiram fb0f8884ad Fix Broken CLI docs (#5148)
* Fix building CLI docs

* Fix contributing docs

   Double colon before block directive is wrong.
2022-06-27 09:40:03 +02:00
ImreC 37b1fb422b Include markers issue #5092 (#5114)
* Include markers

* Change to marker flag and include test

* Flip markers flag to exclude by default

* Docs and newsfile

* Let default dependencies update dev dependencies
2022-06-25 13:23:04 +02:00
ImreC 6e26552628 Update docs and add deprecation warning for lock -r (#5069)
* Update docs and add deprecation warning for lock -r
2022-04-30 10:22:51 +02:00
Matt Davis dc8ac38b1b Allow pipenv option to consider all listed package sources when syncing the Pipfile.lock (#5039)
* Allow option to search all sources during installation.

* Add documentation for new Pipenv option ``install_search_all_sources``.
2022-04-20 21:21:38 -04:00
Jonathan ca8ff553a8 [fix] allow the user to overwrite the no_input flag to pip (#5036)
Support `no_input` flag for when you want to e.g. use keyring to authenticate against Google Artifact Registry.
2022-04-20 19:16:48 -04:00
Matt Davis 6034244498 cleanup stale links (#5048)
* cleanup stale links

* only support one sidebar html file. Address PR feedback.  HTML5 attributes.

* Update sphinx dependenencies

* Corrected CLI patch for new version of sphinx-click.

* fix placement of search bar back to original spot.

* cleanup a sphinx build warning.
2022-04-18 06:59:16 +02:00
Matt Davis 4f676ac9c8 sphinx formatting change and fix CLI docs (#5032)
* sphinx formatting change.

* minor doc formatting improvements.

* check point progress

* Get the CLI docs generating again.

* Add news item for fixed CLI documentation.

* Dont skip build of docs changes.

* fix linting
2022-04-08 11:36:18 +02:00
Matt Davis 99cf729dd5 Improve documentation around index restrictions (#5029)
* Improve documentation around index restrictions

* Update docs/advanced.rst

* Refine index documentation updates.   Factor out and re-use method before closing down other PR.

* Fully remove the --extra-index-url argument

Co-authored-by: Yusuke Nishioka <yusuke.nishioka.0713@gmail.com>
2022-04-06 11:16:13 +02:00
ImreC 63ac0d03a9 Implements requirements command as per #4959 (#5013)
* Implements reqs command

* Add news document

* Process comments

* Rename newsfile

* Adds --dev-only and --hash args

* Linting fixes

Co-authored-by: Imre Persoonlijk <imre1@pop-os.localdomain>
2022-04-05 14:13:33 +02:00
Matt Davis 9a3b3ce706 Issue 4993 Add standard pre commit hooks and apply linting. (#4994)
* Add .pre-commit-config.yaml to the project and exclude tests (for now).  This does not include the MyPy linting that pip does but does include everything else.
2022-03-29 23:01:50 -04:00
Matt Davis 79389f0031 Remove mention of the --two flag and python2 2022-03-12 03:07:48 -05:00
Oz N Tiram ce83c62938 Merge branch 'main' into master 2022-02-10 11:17:28 +01:00
Oz N Tiram 880f91c877 Merge pull request #4896 from den4uk/verify-hash-command
New command: verify Pipfile.lock hash is up to date
2022-02-10 11:14:31 +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
Oz N Tiram aa68371bf4 Merge pull request #4921 from pypa/update-contributing.rst-and-run-tests
Update contributing.rst and run tests
2022-01-14 09:39:40 +01:00
Oz N Tiram ecef2d48e9 Fix some typos in contributing.rst 2022-01-13 13:02:23 +01:00
Oz N Tiram 9a5b14bafd Clarify usage of run-tests.sh
Explain how to override the default Python binary and the
Python version used by pipenv.
2022-01-13 12:54:57 +01:00
Oz N Tiram e8e24444fb Remove circular reference to CONTRIBUING.md
Also restore the link to be cordial ...
2022-01-13 10:08:25 +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 5deb3af86a Remove the philosophy document
This document is no longer useful. KR has stepped down
and all the other maintainers are emeritus.

The rest of the philosophy is exlusive and could be removed
without doing any harm. KR still has earned his respect starting
this project.
2022-01-12 23:44:35 +01:00
Oz N Tiram d59c0de867 Update contributing.rst and refer to in CONTRIBUTING.md
There should be only one document describing how to contribute
to pipenv. Having both documents caused a drift between both.
2022-01-12 23:41:50 +01:00
Denis Sazonov 41e174898c docs update for cli verify command 2022-01-12 09:57:22 +00: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 b12c4fcac4 Update pipenv install output 2022-01-10 14:16:19 +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
belkka aec666e54d Add a clickable link to PEP 508 2021-11-24 05:47:34 +02:00
Frost Ming 1524315baf make the doc more accurate
close #4856
2021-11-11 17:23:13 +08:00
Frost Ming 57d6ce2646 Replace click-completion with click's own completion code 2021-11-09 11:14:42 +08:00
Frost Ming 2da61b03e8 Release v2021.11.5 2021-11-05 18:32:08 +08:00
Frost Ming 1c42fe9fe3 Merge pull request #4659 from perlun/patch-1
diagnose.rst: Remove outdated -c docs
2021-11-05 09:23:23 +08:00
Frost Ming 61497d0a50 Merge pull request #4716 from danawaze/patch-1
Fix basic usage docs to reflect lock -r behaviour
2021-11-05 09:22:57 +08:00
Vipul Kumar ab45240efa docs: Add missing link of Pipx's home page 2021-09-24 20:42:46 +05:30
Frost Ming ca5d931f1f Update to py36 plus syntax 2021-07-28 10:59:00 +08: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
Per Lundberg 06ce13521d diagnose.rst: Remove outdated -c docs 2021-03-26 15:38:24 +02:00
Mohamad A a87d8785aa re-fix broken link 2021-03-08 17:58:11 +02:00
Kongklakker ed6757fc11 Update index.rst
Closes #4462
2021-01-27 20:33:11 +00:00
Frost Ming b10e2cbaca Merge branch 'master' into patch-1 2021-01-19 19:07:52 -06:00
Miguel Calderon cc18160e4e Remove broken link 2020-12-21 18:44:20 -08:00
Sumana Harihareswara a72ee551c1 Remove search link on main page
Partially and temporarily addresses #1839 while we fix the
underlying problem and investigate the search index. Users
will temporarily only be able to use the search box in the
sidebar.

Please revert this once the index is fixed.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-12-16 16:44:23 -05:00
Deepyaman Datta 4144092e5b Fix description of the compatible-release operator 2020-12-14 23:15:57 -05:00
Steve Shanks d38e666746 Update pyenv docs to avoid using shim
Also removed the PIPENV_PYTHON suggestion, as this is likely to cause
confusion if added to e.g. .bashrc - it will always be set to the
global pyenv.

Fixes #4534
2020-11-13 10:55:45 +00:00
Frost Ming a95ed5281f Update the section in document 2020-11-13 11:38:41 +08:00