Commits

Lukasz Balcerzak committed a8b1cc2

Documented 'package' config for test envs

Comments (0)

Files changed (2)

    would be treated as relative to ``{toxinidir}``. **default**:
    ``{toxworkdir}/{envname}``
 
+
+.. confval:: package=BOOL
+
+   .. versionadded:: 1.5
+
+   Set to ``False`` if you don't want tox to perform package-related steps
+   (building source distribution and installing it). Might be useful for
+   non-package projects (i.e. all that lacks ``setup.py`` file). **default**:
+   ``True``.
+
 Substitutions
 ---------------------
 

doc/example/devenv.txt

 Firstly, you need to prepare configuration for your development environment. In
 order to do that, we must define proper section at ``tox.ini`` file and tell at
 what directory environment should be created. Moreover, we need to specify
-python version that should be picked::
+python version that should be picked and tell tox not to perform any package
+related steps::
 
     [testenv:devenv]
     envdir = devenv
     basepython = python2.7
+    package = False
 
 
 Actually, you can configure a lot more, those are the only required settings.
 Here is example configuration for that::
 
     [testenv:devenv]
+    package = False
     envdir = devenv
     changedir = devenv
     basepython = python2.7
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.