Commit Graph

507 Commits

Author SHA1 Message Date
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
Frost Ming 72b571bd06 Change multiple styles in CLI output 2020-11-02 11:11:54 +08:00
David Beitey cda15b3b30 Update sidebar templates
* Make all URLs HTTPS where possible
* Update project URLs
* Make project image title consistent between sidebars

In a similar vein to #3868
2020-10-05 14:59:03 +08:00
David Beitey 38a040c002 Close comment in documentation HTML 2020-10-01 02:54:30 +08:00
Glen Smith 6897ebffa3 Add documentation of new scripts command. 2020-09-08 08:41:48 -06:00
frostming 5a5d238f87 Discourage homebrew installation in doc 2020-08-28 16:45:56 +08: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
dragon788 2458d0802b Remove outdated link that points to placeholder site 2020-07-07 11:00:41 -05:00
Dan Ryan 46f3e5162c Merge branch 'master' into issue-3316-lock-all-deps-with-dev 2020-05-06 21:50:56 -04:00
cocoatomo ecf984dbcc Lacking sphinxcontrib-spelling module
Sphinx build fails with "exception: No module named 'sphinxcontrib.spelling'" error.
sphinxcontrib-spelling was added by https://github.com/pypa/pipenv/commit/2f460a9128ee5c880dcbc52fd2b8de3fe393720a 3days ago.
2020-05-02 20:10:33 +09:00
Dan Ryan 2f460a9128 Add sphinx spellcheck addon (#4209)
Co-Authored-By: Frost Ming <mianghong@gmail.com>
Co-Authored-By: Sumana Harihareswara <sh@changeset.nyc>
2020-04-29 02:39:06 -04:00
Dan Ryan a68166af55 Reword note about pyup
Reword `pipenv check` note in docs

Co-Authored-By: Sumana Harihareswara <sh@changeset.nyc>
2020-04-28 12:19:19 -04:00
Dan Ryan 42321376c9 Update documentation to reflect accurate pyup use
- Remove bits about CC-BY-SA licensing
- Remove bits about using an embedded API key
- Add a little flair to the readme to acknowledge pyup

Signed-off-by: Dan Ryan <dan.ryan@canonical.com>
2020-04-26 02:50:40 -04:00
Nick Coghlan f9761afbdd Merge remote-tracking branch 'origin/master' into issue-3316-lock-all-deps-with-dev 2020-04-12 13:29:03 +10:00
Dan Ryan 5d80f824eb Merge branch 'master' into no-pipenv-org 2020-04-11 22:46:51 -04:00
Nick Coghlan 1e54399de7 Default dependencies, not production dependencies 2020-04-10 15:58:38 +10:00
Nick Coghlan 592cbe54a1 Issue #3316: Include all deps in 'pipenv lock -r --dev'
* Implements PEEP-006
* `pipenv lock -r --dev` is now consistent with other commands
  and the CLI help output, and includes both default and dev
  dependencies in the result
* New `--dev-only` option allows requesting the previous behaviour
  (which was specifically designed to support the traditional
  `requirements.txt`/`dev-requirements.txt` split)
2020-04-10 15:51:58 +10: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
Paul Crowley 7c282aea62 Replace docs.pipenv.org with pipenv.pypa.io
`dig pipenv.org ns` currently shows no nameserver for that domain;
pipenv.pypa.io is the new home for documentation, so use that
everywhere (contributors guides, `pipenv --envs` output).
2020-03-28 06:06:02 -07:00
Frost Ming a883ef5159 Merge pull request #4100 from timhughes/dotenv_docs
Dotenv docs
2020-03-26 10:59:48 +08:00
Sumana Harihareswara d74e7aa310 Update GitHub logo link in docs
Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-03-24 13:19:23 -04:00
Sumana Harihareswara 603a20bf45 Update links in documentation
The canonical Pipenv documentation is now at pipenv.pypa.io.
Also, the canonical GitHub repositories for Pipenv and
Requests have changed, and some other communications links
(Twitter, mailing list, "thank you") were no longer
operational. This commit updates those and clarifies that
Pipenv is a project maintained by the PyPA.

Fixes #4137.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-03-05 20:55:28 -05:00
Tim Hughes 1fcb1b5bc1 [docs] mention variable expansion in .env files
fix #3610
2020-01-15 12:49:14 +00: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
alexanderbarbosa abaa348add Sidebar: Update git-legit to new url address 2019-08-27 22:11:07 -03:00
jxltom c1612d99d7 Move CLI into separate part in docs 2019-08-16 11:18:58 +08:00
Š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
Brett Cannon ac1983402e Touch up sidebar
- Make URLs HTTPS
- Modernize some links
- Remove a non-functioning iframe
- Make an image title more descriptive
2019-07-26 15:07:59 -07:00