Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Mon Feb 01 10:38:16 2021 +0100
@@ -124,6 +124,10 @@
 <td>Public method to get a dictionary containing the defined virtual environment entries.</td>
 </tr>
 <tr>
+<td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td>
+<td>Public method to set the base directory for the virtual environments.</td>
+</tr>
+<tr>
 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
 <td>Public method to get the directory of a virtual environment.</td>
 </tr>
@@ -168,6 +172,10 @@
 <td>Public method to change a virtual environment.</td>
 </tr>
 <tr>
+<td><a href="#VirtualenvManager.setVirtualEnvironmentsBaseDir">setVirtualEnvironmentsBaseDir</a></td>
+<td>Public method to set the base directory for the virtual environments.</td>
+</tr>
+<tr>
 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td>
 <td>Public slot to show the virtual environment manager dialog.</td>
 </tr>
@@ -212,7 +220,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating it can be deleted
 </dd>
@@ -278,11 +286,18 @@
 </dl>
 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
 <h4>VirtualenvManager.createVirtualEnv</h4>
-<b>createVirtualEnv</b>(<i></i>)
+<b>createVirtualEnv</b>(<i>baseDir=""</i>)
 
 <p>
         Public slot to create a new virtual environment.
 </p>
+<dl>
+
+<dt><i>baseDir</i> (str)</dt>
+<dd>
+base directory for the virtual environments
+</dd>
+</dl>
 <a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a>
 <h4>VirtualenvManager.deleteVirtualEnvs</h4>
 <b>deleteVirtualEnvs</b>(<i>venvNames</i>)
@@ -307,10 +322,10 @@
 <p>
         Default is an environment with the key '<default>' or the first one
         having an interpreter matching sys.executable (i.e. the one used to
-        execute eric6 with)
+        execute eric with)
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing the environment name and a dictionary
             containing a copy of the default virtual environment
@@ -331,7 +346,7 @@
         environment entries.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 dictionary containing a copy of the defined virtual
             environments
@@ -343,6 +358,25 @@
 dict
 </dd>
 </dl>
+<a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a>
+<h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4>
+<b>getVirtualEnvironmentsBaseDir</b>(<i></i>)
+
+<p>
+        Public method to set the base directory for the virtual environments.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+base directory for the virtual environments
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
 <h4>VirtualenvManager.getVirtualenvDirectory</h4>
 <b>getVirtualenvDirectory</b>(<i>venvName</i>)
@@ -358,7 +392,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 directory path
 </dd>
@@ -384,7 +418,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 search path prefix
 </dd>
@@ -410,7 +444,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 interpreter path
 </dd>
@@ -441,7 +475,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of defined virtual environments
 </dd>
@@ -468,7 +502,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating an Anaconda environment
 </dd>
@@ -494,7 +528,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a global environment
 </dd>
@@ -521,7 +555,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a remotely accessed environment
 </dd>
@@ -547,7 +581,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating uniqueness
 </dd>
@@ -655,6 +689,20 @@
             environment variable
 </dd>
 </dl>
+<a NAME="VirtualenvManager.setVirtualEnvironmentsBaseDir" ID="VirtualenvManager.setVirtualEnvironmentsBaseDir"></a>
+<h4>VirtualenvManager.setVirtualEnvironmentsBaseDir</h4>
+<b>setVirtualEnvironmentsBaseDir</b>(<i>baseDir</i>)
+
+<p>
+        Public method to set the base directory for the virtual environments.
+</p>
+<dl>
+
+<dt><i>baseDir</i> (str)</dt>
+<dd>
+base directory for the virtual environments
+</dd>
+</dl>
 <a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>)