Document how to replace deprecated indexserver configuration directive. #1976
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zejn
requested review from
asottile,
gaborbernat and
obestwalter
as code owners
gaborbernat
requested changes
Mar 15, 2021
docs/config.rst
Outdated
| (DEPRECATED, will be removed in a future version) Multi-line ``name = | ||
| URL`` definitions of python package servers. Dependencies can | ||
| specify using a specified index server through the | ||
| (DEPRECATED, will be removed in a future version) Use |
There was a problem hiding this comment.
IMHO a better way to specify the index server is to do:
setenv =
PIP_INDEX_URL = {env:PIP_INDEX_URL:https://magic.com/simple}
There was a problem hiding this comment.
I agree.
I've changed the commit so there's only a note at the top, following is the description of indexserver configuration option and last is the new recommendation.
I've changed magic.com/simple to pypi.org/simple to avoid someone getting magic.com. (example.com could also be used).
added 2 commits
March 27, 2021 11:02
The `install_command` directive lists it can configure index server, but the `indexserver` directive does not point to that. This PR adds this link. I have verified the documentation builds ok with `tox -e docs`.
gaborbernat
approved these changes
Mar 27, 2021
jugmac00
reviewed
Mar 27, 2021
docs/config.rst
Outdated
| @@ -553,6 +555,17 @@ Complete list of settings that you can put into ``testenv*`` sections: | |||
| will make tox install all dependencies from this PyPI index server | |||
| (including when installing the project sdist package). | |||
|
|
|||
| The recommended way to set custom index server URL is to use :conf:`setenv`: | |||
There was a problem hiding this comment.
Suggested change
| The recommended way to set custom index server URL is to use :conf:`setenv`: | |
| The recommended way to set a custom index server URL is to use :conf:`setenv`: |
jugmac00
reviewed
Mar 27, 2021
docs/config.rst
Outdated
| PIP_INDEX_URL = {env:PIP_INDEX_URL:https://pypi.org/simple/} | ||
|
|
||
| This will ensure the desired index server gets used for virtual environment | ||
| creation and allow overriding index server URL with environment variable. |
There was a problem hiding this comment.
Suggested change
| creation and allow overriding index server URL with environment variable. | |
| creation and allow overriding the index server URL with an environment variable. |
jugmac00
reviewed
Mar 27, 2021
docs/config.rst
Outdated
| to configure PIP_INDEX_URL environment variable, see below. | ||
|
|
||
| Multi-line ``name = URL`` definitions of python package servers. | ||
| Dependencies can specify using a specified index server through the |
There was a problem hiding this comment.
Suggested change
| Dependencies can specify using a specified index server through the | |
| You can specify an alternative index server for dependencies by applying the |
ssbarnea
pushed a commit
to ssbarnea/tox
that referenced
this pull request
Apr 19, 2021
…e. (tox-dev#1976) Co-authored-by: Gasper Zejn <zelo.zejn@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
install_commanddirective lists it can configure index server, but theindexserverdirective does not point to that. This PR adds this link.I have verified the documentation builds ok with
tox -e docs.