Commit Graph

116 Commits

Author SHA1 Message Date
Oz N Tiram 3660a3f149 Create a new man page and add a quickstart
Previously, the changelog was included inside the man page,
which made the man page totally unreadable.
This new man page is terse, as is the norm, in man pages.
It is is also re-used as a quickstart in the landing page of the
documentation.
2022-10-24 11:12:07 +02:00
Oz N Tiram c64654717d Move Changelog to the bottom of the document 2022-10-24 10:56:34 +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 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
belkka aec666e54d Add a clickable link to PEP 508 2021-11-24 05:47:34 +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
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
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
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
jxltom c1612d99d7 Move CLI into separate part in docs 2019-08-16 11:18:58 +08:00
jlusk 463820f5f0 change URL for GIF 2019-07-16 07:41:16 -04:00
frostming 79a12c35db Add missing blank line in code block 2019-07-15 13:59:17 +08:00
frostming f4db1dc7a9 Serve animation statically 2019-07-15 09:55:54 +08:00
Frost Ming d7dd54e2a3 Merge branch 'master' into patch-2 2019-03-07 17:36:19 +08:00
Jannis Leidel e2738a8aef Removing jezdez's testimonial (#3536)
As requested
2019-03-07 13:29:27 +08:00
Frank Anderson d0e35135a0 Update index.rst
Fix for #3499
2019-02-08 14:35:00 -08:00
jxltom 844f7f80e2 Merge homebrew and linuxbrew installation into same section 2018-12-16 10:45:29 +08:00
Omer Katz d191deb744 Mention Linuxbrew in installation docs. 2018-12-04 17:50:41 +02:00
Pavel Sviderski 21d53570f3 add try-in-browser button to docs 2018-10-25 20:15:23 +03:00
Aditya Srivastava 4588ffebda Added shell deactivation instruction to documentation
Minor edits to documentation
2018-10-07 09:24:25 +05:30
Tzu-ping Chung 4fb6cc3631 Installation documentation updates
Removed ppa mentions from documentation, and re-organised the page a bit
to make it structurally easier to upderstand.

Both the documentation's front page and README.rst now actively refer to
the page so user can be directed to better installation methods. (I
don't think this is very useful TBT because people don't use manuals,
but we should still do it.)

Also fixed many Sphinx warnings during documentation builds.
2018-07-11 13:45:37 +08:00
Dan Ryan 46ba42b6fb Add changelog, update documentation home screen
Signed-off-by: Dan Ryan <dan@danryan.co>
2018-07-01 17:00:44 -04:00
muxator 0ab11ccb68 punctuation: removed unnecessary comma 2018-06-06 10:18:50 +02:00
kennethreitz 47debed9a1 simplicity
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-19 14:34:18 -04:00
kennethreitz fe78628903 opinionated
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-19 14:25:27 -04:00
kennethreitz e3c72e167d cleanup
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-19 14:18:27 -04:00
kennethreitz 1c956d37e6 one line
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-19 14:16:47 -04:00
kennethreitz 6d77e4a055 let's be honest here
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-19 14:15:02 -04:00
kennethreitz 5e503e5b26 one line
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-16 12:09:13 -04:00
kennethreitz 171bb99e94 even shorter
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-16 12:08:48 -04:00
kennethreitz 5853846f5d pipenv shortened
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-05-16 12:07:56 -04:00
Jon Wayne Parrott 9ba2324298 Update the wording a little 2018-05-15 11:08:45 -07:00
Jon Wayne Parrott 71bf8e5130 Update the wording to clarify Pipenv's overall role in the packaging ecosystem 2018-05-15 09:25:31 -07:00
Tom Eastman 824dcb74e2 Suggest pip as the first recommended installation method instead of Homebrew. 2018-04-28 09:48:44 +12:00
Tzu-ping Chung fed9569f9a Add faq page 2018-03-20 02:13:15 +08:00
Kalle Jepsen 05a82a2b2d Add section on distinction between setup.py and Pipfile 2018-03-14 13:16:59 +01:00
kennethreitz e7cbc01ced reorder
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-08 17:14:55 -05:00
kennethreitz 6ec9438d96 cleanup
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-08 17:13:50 -05:00
kennethreitz 612d991613 new testimonial
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-08 17:13:02 -05:00
kennethreitz 685017e216 community integrations
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-07 12:59:40 -05:00
Paul Walsh 6b16531934 Add editor integrations. 2018-03-07 19:13:19 +02:00
kennethreitz 967fabd4e8 more packages
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-07 08:47:40 -05:00
kennethreitz fa89b80585 pypa ppa
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-07 07:57:51 -05:00
kennethreitz 45eaabebbd better ppa install instructions
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-07 07:15:22 -05:00
kennethreitz f745a5cec9 Or, if you're using Ubuntu 17.10::
$ sudo apt install python-software-properties
    $ sudo add-apt-repository ppa:kennethreitz/pipenv
    $ sudo apt update
    $ sudo apt install python3-pipenv

Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-07 05:28:30 -05:00
kennethreitz 2ef13775fd remove installation recommendation
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-02 18:54:19 -05:00
kennethreitz b3b049e679 Update index.rst 2018-03-02 09:49:21 -05:00