From 767ff0b5bcbbc48dc17317e0bd027c220f80b867 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sat, 9 Sep 2017 12:28:14 -0400 Subject: [PATCH] sphinx click Signed-off-by: Kenneth Reitz --- docs/conf.py | 3 ++- docs/index.rst | 57 ++++---------------------------------------------- 2 files changed, 6 insertions(+), 54 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2e5b3e5c..71f307ad 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,8 @@ with open(os.path.join(here, "..", "pipenv", "__version__.py")) as f: extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', - 'sphinx.ext.viewcode'] + 'sphinx.ext.viewcode', + 'sphinx_click.ext'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/index.rst b/docs/index.rst index 372cf682..b889beea 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,6 +40,7 @@ The problems that Pipenv seeks to solve are multi-faceted: - Managing a ``requirements.txt`` file `can be problematic `_, so Pipenv uses the upcoming ``Pipfile`` and ``Pipfile.lock`` instead, which is superior for basic use cases. - Hashes are used everywhere, always. Security. + Install Pipenv Today! --------------------- @@ -103,59 +104,9 @@ Other Commands ☤ Pipenv Usage -------------- -:: - - $ pipenv - Usage: pipenv [OPTIONS] COMMAND [ARGS]... - - Options: - --where Output project home information. - --venv Output virtualenv information. - --rm Remove the virtualenv. - --bare Minimal output. - --three / --two Use Python 3/2 when creating virtualenv. - --python TEXT Specify which version of Python virtualenv should use. - -h, --help Show this message then exit. - --version Show the version and exit. - - - Usage Examples: - Create a new project using Python 3: - $ pipenv --three - - Install all dependencies for a project (including dev): - $ pipenv install --dev - - Create a lockfile: - $ pipenv lock - - Commands: - check Checks PEP 508 markers provided in Pipfile. - install Installs provided packages and adds them to... - lock Generates Pipfile.lock. - run Spawns a command installed into the... - shell Spawns a shell within the virtualenv. - uninstall Un-installs a provided package and removes it... - update Updates pip to latest version, uninstalls all... - -:: - - $ pipenv --where - Pipfile found at /Users/kennethreitz/repos/kr/pip2/test/Pipfile. Considering this to be the project home. - -:: - - $ pipenv install - Creating a virtualenv for this project... - ... - No package provided, installing all dependencies. - Virtualenv location: /Users/kennethreitz/repos/kr/pip2/test/.venv - Installing dependencies from Pipfile.lock... - ... - - To activate this project's virtualenv, run the following: - $ pipenv shell - +.. click:: pipenv:cli + :prog: pipenv + :show-nested: Further Documentation Guides ----------------------------