summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorholger krekel <holger@merlinux.eu>2010-11-08 21:11:29 +0100
committerholger krekel <holger@merlinux.eu>2010-11-08 21:11:29 +0100
commit3093b717d5e1a06794a6f25aaf2f1a9970f5027c (patch)
treeaaca248fe1e620884eae2857069afeb8dc59630a /doc
parent88f88064adca85e6d1668a722e574b2dc2787b21 (diff)
downloadtox-3093b717d5e1a06794a6f25aaf2f1a9970f5027c.tar.gz
actually use a simpler indexserver definition after all
Diffstat (limited to 'doc')
-rw-r--r--doc/config.txt24
-rw-r--r--doc/example/basic.txt21
2 files changed, 28 insertions, 17 deletions
diff --git a/doc/config.txt b/doc/config.txt
index 61e32c8..10d1da5 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -135,21 +135,23 @@ Complete list of settings that you can put into ``testenv*`` sections:
have access to globally installed packages. **default:** False, meaning
that virtualenvs will be created with ``--no-site-packages`` by default.
-Index Server sections and settings
--------------------------------------------
+.. confval:: indexserver
+
+ .. versionadded:: 0.9
-Index servers can be specified by using the ``indexserver`` prefix
-in section names::
+ Multi-line ``name = URL`` definitions of python package servers.
+ Depedencies can specify using a specified index server through the
+ ``:indexservername:depname`` pattern. The ``default`` indexserver
+ definition determines where unscoped dependencies and the sdist install
+ comes from. Example::
- [indexserver:NAME]
- url = XYZ
+ [tox]
+ indexserver =
+ default = http://mypypi.org
-Currently there is only one config option, ``url``, an URL
-to pass to ``pip_install`` or ``easy_install``.
+ will make tox install all dependencies from this PYPI index server
+ (including when installing the project sdist package).
-If you want to modify the default url definition you can use
-a ``[indexserver]`` definition. This will be used for all
-unqualified dependency and sdist installations.
Substitutions
---------------------
diff --git a/doc/example/basic.txt b/doc/example/basic.txt
index deeff98..abcb37e 100644
--- a/doc/example/basic.txt
+++ b/doc/example/basic.txt
@@ -51,14 +51,19 @@ using a different default PyPI url
.. versionadded: 0.9
To install dependencies and packages from a different
-default PyPI server type::
+default PyPI server you can type interactively::
tox -i http://pypi.testrun.org
This causes tox to install dependencies and the sdist install step
to use the specificied url as the index server.
-installing dependencies from multiple PyPI server
+You can cause the same effect by this ``tox.ini`` section::
+
+ [indexserver]
+ url = http://pypi.testrun.org
+
+installing dependencies from multiple PyPI servers
---------------------------------------------------
.. versionadded: 0.9
@@ -66,20 +71,24 @@ installing dependencies from multiple PyPI server
You can instrument tox to install dependencies from
different PyPI servers, example::
- [indexserver:DEV]
- url = http://mypypiserver.org
+ [tox]
+ indexserver =
+ DEV = http://mypypiserver.org
[testenv]
deps =
docutils # comes from standard PyPI
:DEV:mypackage # will be installed from custom "DEV" pypi url
-Using the ``-i`` command line option you can override index urls::
+This configuration will install ``docutils`` from the default
+Python PYPI server and will install the ``mypackage`` from
+our ``DEV`` indexserver, and the respective ``http://mypypiserver.org``
+url. You can override config file settings from the command line
+like this::
tox -i DEV=http://pypi.python.org/simple # changes :DEV: package URLs
tox -i http://pypi.python.org/simple # changes default
-
forcing re-creation of virtual environments
-----------------------------------------------