--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,25 +7,23 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions</h1>
-
<p>
Module implementing variants of some 'circup' functions suitable for 'eric-ide'
integration.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#ensure_latest_bundle">ensure_latest_bundle</a></td>
<td>Function to ensure that there's a copy of the latest library bundle available so circup can check the metadata contained therein.</td>
@@ -47,16 +45,17 @@
<td>Function to patch 'circup' to use our functions adapted to the use within the eric-ide.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="ensure_latest_bundle" ID="ensure_latest_bundle"></a>
<h2>ensure_latest_bundle</h2>
<b>ensure_latest_bundle</b>(<i>bundle</i>)
-
<p>
Function to ensure that there's a copy of the latest library bundle available so
circup can check the metadata contained therein.
</p>
+
<dl>
<dt><i>bundle</i> (circup.Bundle)</dt>
@@ -70,11 +69,11 @@
<a NAME="find_modules" ID="find_modules"></a>
<h2>find_modules</h2>
<b>find_modules</b>(<i>device_path, bundles_list</i>)
-
<p>
Function to extract metadata from the connected device and available bundles and
returns this as a list of Module instances representing the modules on the device.
</p>
+
<dl>
<dt><i>device_path</i> (str)</dt>
@@ -105,7 +104,6 @@
<a NAME="get_circuitpython_version" ID="get_circuitpython_version"></a>
<h2>get_circuitpython_version</h2>
<b>get_circuitpython_version</b>(<i>device_path</i>)
-
<p>
Function to return the version number of CircuitPython running on the board
connected via ``device_path``, along with the board ID.
@@ -123,6 +121,7 @@
<p>
Board ID:raspberry_pi_pico
</p>
+
<dl>
<dt><i>device_path</i> (str)</dt>
@@ -148,7 +147,6 @@
<a NAME="install_module" ID="install_module"></a>
<h2>install_module</h2>
<b>install_module</b>(<i>device_path, device_modules, name, py, mod_names</i>)
-
<p>
Function to find a connected device and install a given module name.
</p>
@@ -156,6 +154,7 @@
Installation is done if it is available in the current module bundle and is not
already installed on the device.
</p>
+
<dl>
<dt><i>device_path</i> (str)</dt>
@@ -199,11 +198,11 @@
<a NAME="patch_circup" ID="patch_circup"></a>
<h2>patch_circup</h2>
<b>patch_circup</b>(<i></i>)
-
<p>
Function to patch 'circup' to use our functions adapted to the use within the
eric-ide.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
