src/eric7/Documentation/Source/eric7.CondaInterface.__init__.html

Fri, 27 Oct 2023 14:09:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 27 Oct 2023 14:09:40 +0200
branch
eric7
changeset 10259
b51dfacef37f
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Regenerated the source documentation with the corrected module parser.

<!DOCTYPE html>
<html><head>
<title>eric7.CondaInterface.__init__</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CondaInterface.__init__</h1>

<p>
Package implementing the various conda related modules.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>__CondaRootPrefix</td></tr><tr><td>__CondaUserConfig</td></tr><tr><td>__CondaVersion</td></tr><tr><td>__CondaVersionStr</td></tr><tr><td>__initialized</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#__initializeCondaInterface">__initializeCondaInterface</a></td>
<td>Private module function to (re-)initialize the conda interface.</td>
</tr>
<tr>
<td><a href="#condaVersion">condaVersion</a></td>
<td>Module function to get the conda version.</td>
</tr>
<tr>
<td><a href="#condaVersionStr">condaVersionStr</a></td>
<td>Module function to get the conda version as a string.</td>
</tr>
<tr>
<td><a href="#isCondaAvailable">isCondaAvailable</a></td>
<td>Module function to check the availability of conda.</td>
</tr>
<tr>
<td><a href="#resetInterface">resetInterface</a></td>
<td>Module function to reset the conda interface.</td>
</tr>
<tr>
<td><a href="#rootPrefix">rootPrefix</a></td>
<td>Module function to get the root prefix.</td>
</tr>
<tr>
<td><a href="#userConfiguration">userConfiguration</a></td>
<td>Module function to get the path of the user configuration file.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="__initializeCondaInterface" ID="__initializeCondaInterface"></a>
<h2>__initializeCondaInterface</h2>
<b>__initializeCondaInterface</b>(<i></i>)

<p>
    Private module function to (re-)initialize the conda interface.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="condaVersion" ID="condaVersion"></a>
<h2>condaVersion</h2>
<b>condaVersion</b>(<i></i>)

<p>
    Module function to get the conda version.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple containing the conda version
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, int, int)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="condaVersionStr" ID="condaVersionStr"></a>
<h2>condaVersionStr</h2>
<b>condaVersionStr</b>(<i></i>)

<p>
    Module function to get the conda version as a string.
</p>
<dl>
<dt>Return:</dt>
<dd>
conda version as a string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="isCondaAvailable" ID="isCondaAvailable"></a>
<h2>isCondaAvailable</h2>
<b>isCondaAvailable</b>(<i></i>)

<p>
    Module function to check the availability of conda.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating conda availability
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="resetInterface" ID="resetInterface"></a>
<h2>resetInterface</h2>
<b>resetInterface</b>(<i></i>)

<p>
    Module function to reset the conda interface.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="rootPrefix" ID="rootPrefix"></a>
<h2>rootPrefix</h2>
<b>rootPrefix</b>(<i></i>)

<p>
    Module function to get the root prefix.
</p>
<dl>
<dt>Return:</dt>
<dd>
root prefix
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="userConfiguration" ID="userConfiguration"></a>
<h2>userConfiguration</h2>
<b>userConfiguration</b>(<i></i>)

<p>
    Module function to get the path of the user configuration file.
</p>
<dl>
<dt>Return:</dt>
<dd>
path of the user configuration file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial