Update documentation

This commit is contained in:
Joel Klimont 2022-11-18 16:46:58 +01:00
parent 64ff14b9b1
commit 75185f19b6
36 changed files with 14537 additions and 3800 deletions

View file

@ -1,71 +1,30 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Stichwortverzeichnis &mdash; CompLib 0.2.3 Dokumentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Stichwortverzeichnis &mdash; CompLib 0.2.3 Dokumentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/translations.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="#" />
<link rel="search" title="Suche" href="search.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/compair-logo-white.svg" class="logo" alt="Logo"/>
<a href="index.html"><img src="_static/compair-logo-white.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
@ -73,18 +32,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="gettingStarted/index.html">Erste Schritte</a></li>
<li class="toctree-l1"><a class="reference internal" href="software/installation.html">Installationsanweisungen</a></li>
@ -94,72 +42,35 @@
<li class="toctree-l1"><a class="reference internal" href="other/hardware.html">Hardware</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">CompLib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Stichwortverzeichnis</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Stichwortverzeichnis</h1>
<div class="genindex-jumpbox">
<a href="#D"><strong>D</strong></a>
<a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#I"><strong>I</strong></a>
@ -169,14 +80,28 @@
| <a href="#S"><strong>S</strong></a>
</div>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera">Camera (Klasse in compLib.Camera)</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/IRSensor.html#compLib.IRSensor.IRSensor.disable">disable() (statische Methode von compLib.IRSensor.IRSensor)</a>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera.detect_markers">detect_markers() (Methode von compLib.Camera.Camera)</a>
</li>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera.detect_markers_midpoint">detect_markers_midpoint() (Methode von compLib.Camera.Camera)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/IRSensor.html#compLib.IRSensor.IRSensor.disable">disable() (statische Methode von compLib.IRSensor.IRSensor)</a>
</li>
<li><a href="lib/classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim">DoubleElim (Klasse in compLib.DoubleElimination)</a>
</li>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera.draw_markers">draw_markers() (Methode von compLib.Camera.Camera)</a>
</li>
</ul></td>
</tr></table>
@ -197,6 +122,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Seeding.html#compLib.Seeding.Gamestate">Gamestate (Klasse in compLib.Seeding)</a>
</li>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera.get_frame">get_frame() (Methode von compLib.Camera.Camera)</a>
</li>
<li><a href="lib/classes/DoubleElimination.html#compLib.DoubleElimination.DoubleElim.get_goal">get_goal() (statische Methode von compLib.DoubleElimination.DoubleElim)</a>
</li>
@ -230,12 +157,14 @@
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor">Motor (Klasse in compLib.Motor)</a>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Marker">Marker (Klasse in compLib.Camera)</a>
</li>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.multiple_power">multiple_power() (statische Methode von compLib.Motor.Motor)</a>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor">Motor (Klasse in compLib.Motor)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.multiple_power">multiple_power() (statische Methode von compLib.Motor.Motor)</a>
</li>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.multiple_pulse_width">multiple_pulse_width() (statische Methode von compLib.Motor.Motor)</a>
</li>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.multiple_speed">multiple_speed() (statische Methode von compLib.Motor.Motor)</a>
@ -247,10 +176,12 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/DoubleElimination.html#compLib.DoubleElimination.Position">Position (Klasse in compLib.DoubleElimination)</a>
</li>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.power">power() (statische Methode von compLib.Motor.Motor)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.power">power() (statische Methode von compLib.Motor.Motor)</a>
<li><a href="lib/classes/Opencv.html#compLib.Camera.Camera.publish_frame">publish_frame() (Methode von compLib.Camera.Camera)</a>
</li>
<li><a href="lib/classes/Motor.html#compLib.Motor.Motor.pulse_width">pulse_width() (statische Methode von compLib.Motor.Motor)</a>
</li>
@ -282,49 +213,30 @@
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS)
</p>
<p>&#169; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
</div>
Erstellt mit <a href="http://sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>