summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-05-20 13:34:53 +0100
committerw0rp <devw0rp@gmail.com>2017-05-20 13:34:53 +0100
commit65fbf1cdff316090f404bb65f8c8a54a00551650 (patch)
treeae80afc3a50d5cdc4058f79ea62cf4702d00ab5d /doc
parentd012fd1f09c4ffb89130110fa37d4e10fb1c9b6b (diff)
downloadale-65fbf1cdff316090f404bb65f8c8a54a00551650.zip
#563 Use a configurable list of directories for detecting virtualenv paths instead.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 29646714..0a8b7088 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -3,6 +3,21 @@ ALE Python Integration *ale-python-options*
-------------------------------------------------------------------------------
+Global Options
+
+g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
+ *b:ale_virtualenv_dir_names*
+
+ Type: |List|
+ Default: `['.env', 'env', 've', 've-py3', 'virtualenv']`
+
+ A list of directory names to be used when searching upwards from Python
+ files to discover virtulenv directories with. For directory named `'foo'`,
+ ALE will search for `'foo/bin/activate'` in all directories on and above
+ the directory containing the Python file to find virtualenv paths.
+
+
+-------------------------------------------------------------------------------
flake8 *ale-python-flake8*
g:ale_python_flake8_executable *g:ale_python_flake8_executable*