nwegy/Rigol-DG2052-Function-Generator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Feature: Added Documentation in

Browse Source
This commit is contained in:
Ali Nwegy
2024-03-01 10:44:15 +01:00
parent 2ee2b10c40
commit 16b9105873
51 changed files with 783 additions and 1187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/moduleIndex.html
View File

@@ -139,7 +139,7 @@
</div>
</div>
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">fn_gen</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.common.html" class="internal-link" title="fn_gen.common">common</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm_method</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep_signal_type</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep_spacing</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep_trigger_slope</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li></ul></li><li><code><a href="fn_gen.errors.html" class="internal-link" title="fn_gen.errors">errors</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.errors.undefined_communication_method_error.html" class="internal-link" title="fn_gen.errors.undefined_communication_method_error">undefined_communication_method_error</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.errors.undefined_value_error.html" class="internal-link" title="fn_gen.errors.undefined_value_error">undefined_value_error</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.errors.value_out_of_bounds_error.html" class="internal-link" title="fn_gen.errors.value_out_of_bounds_error">value_out_of_bounds_error</a></code> - <span class="undocumented">Undocumented</span></li></ul></li></ul></li></ul>
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">fn_gen</a></code> - A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)<ul><li><code><a href="fn_gen.common.html" class="internal-link" title="fn_gen.common">common</a></code> - Common functions that are used all over the package</li><li><code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code> - The main funciton generator module</li><li><code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code> - Some enums that are used within this package<ul><li><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm_method</a></code> - Communication Method Enumeration</li><li><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep_signal_type</a></code> - Enumeration representing the different signal types used in a sweep</li><li><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep_spacing</a></code> - The spacings used for the sweep</li><li><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep_trigger_slope</a></code> - The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></li><li><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> - The different sources available to trigger a sweep</li></ul></li><li><code><a href="fn_gen.errors.html" class="internal-link" title="fn_gen.errors">errors</a></code> - A combination of errors used within the package<ul><li><code><a href="fn_gen.errors.undefined_communication_method_error.html" class="internal-link" title="fn_gen.errors.undefined_communication_method_error">undefined_communication_method_error</a></code> - An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</li><li><code><a href="fn_gen.errors.undefined_value_error.html" class="internal-link" title="fn_gen.errors.undefined_value_error">undefined_value_error</a></code> - An error used when the value used is not defined</li><li><code><a href="fn_gen.errors.value_out_of_bounds_error.html" class="internal-link" title="fn_gen.errors.value_out_of_bounds_error">value_out_of_bounds_error</a></code> - An error used when the value used is out of bounds for the function</li></ul></li></ul></li></ul>
</div>
@@ -149,7 +149,7 @@
<div class="container">
<a href="index.html">API Documentation</a> for fn_gen,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
23.9.1 at 2024-02-06 18:56:15.
23.9.1 at 2024-02-29 14:55:42.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML