Commit Graph

18 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 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
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 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
Frost Ming 2da61b03e8 Release v2021.11.5 2021-11-05 18:32:08 +08:00
Frost Ming ca5d931f1f Update to py36 plus syntax 2021-07-28 10:59:00 +08: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 c1a9f0079c Resort imports for docs 2018-12-01 19:11:55 +08:00
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
Tzu-ping Chung 9bd49f9759 Automatically generate environment variable docs
Default values are added to docstrings so they appear in the docs.
This should help maintainers to keep them up-to-date.

Fix #2547.
2018-07-10 18:38:15 +08:00
kennethreitz 6415f980af fix sidebar for github links
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-02-20 10:05:27 -05:00
kennethreitz d64becd8ec new github logo
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2017-09-27 13:13:07 -04:00
kennethreitz 767ff0b5bc sphinx click
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2017-09-09 12:28:14 -04:00
kennethreitz c848cb9d8c pipenv home 2017-01-30 14:03:01 -05:00
kennethreitz baca5cc62b get current version info in docs 2017-01-30 13:49:32 -05:00
kennethreitz 04bcfaeb68 docs basics 2017-01-30 13:30:04 -05:00