Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve documentation for install_command #2111

Merged
merged 2 commits into from Jul 21, 2021
Merged

improve documentation for install_command #2111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d830dcc
improve documentation for `install_command`
jugmac00 Jul 20, 2021
cbf5689
PR Feedback
gaborbernat Jul 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog/2081.doc.rst
View file
Open in desktop
@@ -0,0 +1 @@
The documentation of ``install_command`` now also mentions that you can provide arbitrary commands - by :user:`jugmac00`
7 changes: 7 additions & 0 deletions docs/config.rst
View file
Open in desktop
Expand Up @@ -306,6 +306,13 @@ Complete list of settings that you can put into ``testenv*`` sections:
such as ``--pre`` (configured as ``pip_pre``) and potentially index-options from the
deprecated :conf:`indexserver` option.

.. note::

You can also provide arbitrary commands to the ``install_command``. Please take care that these commands can be
executed on the supported operating systems. When executing shell scripts we recommend to not specify the script
directly but instead pass it to the appropriate shell as argument (e.g. prefer ``bash script.sh`` over
``script.sh``).

.. conf:: list_dependencies_command ^ ARGV ^ python -m pip freeze

.. versionadded:: 2.4
Expand Down