The Docker example in the Basic Usage document needed a bit of TLC. Because the name of the virtualenv changed between the builder and the runtime container, Python was unable to find itself or its site-packages directory:
coolio@674956d0c53e:/usr/src$ ./venv/bin/pip
bash: ./venv/bin/pip: /usr/src/.venv/bin/python: bad interpreter: No such file or directory
To fix this, I changed the directory of the virtualenv in the runtime container to .venv which matches the builder.
I also added an example of how to get run.py into the container in the first place, since we run it later.
* 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.
* 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.
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
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.
Previously it was confusing as to what `" "` meant exactly -- I read it
as a whitespace character was needed somewhere when it's referring to
the double quote characters.
Small changes, but a couple of issues in the `A Note About VCS Dependencies` section of the docs.
Running the example `$ pipenv install -e git+https://github.com/requests/requests.git@v2.19#egg=requests` raises the error: `Did not find branch or tag 'v2.19', assuming revision or ref.` I think it should be 'v2.19.1' which is just a typo as 'v2.19.1' is used in the subsequent lines of the example.
The example Pipfile in the section excludes the `v` in the version number written to the `ref = ` part. I found it a little confusing that it would strip the 'v' from the tag, but then on testing it I found that it doesn't do that:
```
[packages]
requests = {editable = true, ref = "v2.20.1", git = "https://github.com/requests/requests.git"}
```
Also, while I was here I figured I'd update the example to the most recent requests release.
Thanks.
By default, `pipenv install` will install packages
based on the list in `Pipfile`, not `Pipfile.lock`.
`pipenv install --dev` is no exception.
I've tested this using pipenv 2018.7.1
with different package versions in `Pipfile`
and `Pipfile.lock`. After `pipenv install`,
the versions in `Pipfile` were the ones
actually installed.
Matt Davis