update docs

This commit is contained in:
github-actions
2023-07-24 09:38:45 +00:00
parent 322f54cda7
commit bb6dea764a
11 changed files with 38 additions and 932 deletions

View File

@@ -43,9 +43,9 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html">Inkycal</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.display.display">Display</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.custom.functions">Custom functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.modules.ical_parser">Helper classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#display">Display</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#custom-functions">Custom functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="inkycal.html#helper-classes">Helper classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About Inkycal</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev_doc.html">Developer documentation</a></li>
@@ -78,247 +78,8 @@
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#W"><strong>W</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.main.Inkycal.add_module">add_module() (inkycal.main.Inkycal class method)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.all_day">all_day() (inkycal.modules.ical_parser.iCalendar static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.custom.functions.auto_fontsize">auto_fontsize() (in module inkycal.custom.functions)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.autoflip">autoflip() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.display.display.Display.calibrate">calibrate() (inkycal.display.display.Display method)</a>
<ul>
<li><a href="inkycal.html#inkycal.main.Inkycal.calibrate">(inkycal.main.Inkycal method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.clear">clear() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.clear_events">clear_events() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
<li><a href="inkycal.html#inkycal.main.Inkycal.countdown">countdown() (inkycal.main.Inkycal method)</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="inkycal.html#inkycal.display.display.Display">Display (class in inkycal.display.display)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.custom.functions.draw_border">draw_border() (in module inkycal.custom.functions)</a>
</li>
</ul></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.flip">flip() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.display.display.Display.get_display_names">get_display_names() (inkycal.display.display.Display class method)</a>
</li>
<li><a href="inkycal.html#inkycal.display.display.Display.get_display_size">get_display_size() (inkycal.display.display.Display method)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.get_events">get_events() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.custom.functions.get_fonts">get_fonts() (in module inkycal.custom.functions)</a>
</li>
<li><a href="inkycal.html#inkycal.custom.functions.get_system_tz">get_system_tz() (in module inkycal.custom.functions)</a>
<ul>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.get_system_tz">(inkycal.modules.ical_parser.iCalendar static method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar">iCalendar (class in inkycal.modules.ical_parser)</a>
</li>
<li><a href="inkycal.html#inkycal.main.Inkycal">Inkycal (class in inkycal.main)</a>
</li>
<li>
inkycal.custom.functions
<ul>
<li><a href="inkycal.html#module-inkycal.custom.functions">module</a>
</li>
</ul></li>
<li>
inkycal.display.display
<ul>
<li><a href="inkycal.html#module-inkycal.display.display">module</a>
</li>
</ul></li>
<li>
inkycal.main
<ul>
<li><a href="inkycal.html#module-inkycal.main">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
inkycal.modules.ical_parser
<ul>
<li><a href="inkycal.html#module-inkycal.modules.ical_parser">module</a>
</li>
</ul></li>
<li>
inkycal.modules.inky_image
<ul>
<li><a href="inkycal.html#module-inkycal.modules.inky_image">module</a>
</li>
</ul></li>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage">Inkyimage (class in inkycal.modules.inky_image)</a>
</li>
<li><a href="inkycal.html#inkycal.custom.functions.internet_available">internet_available() (in module inkycal.custom.functions)</a>
</li>
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.load">load() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.load_from_file">load_from_file() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.load_url">load_url() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.merge">merge() (inkycal.modules.inky_image.Inkyimage static method)</a>
</li>
<li>
module
<ul>
<li><a href="inkycal.html#module-inkycal.custom.functions">inkycal.custom.functions</a>
</li>
<li><a href="inkycal.html#module-inkycal.display.display">inkycal.display.display</a>
</li>
<li><a href="inkycal.html#module-inkycal.main">inkycal.main</a>
</li>
<li><a href="inkycal.html#module-inkycal.modules.ical_parser">inkycal.modules.ical_parser</a>
</li>
<li><a href="inkycal.html#module-inkycal.modules.inky_image">inkycal.modules.inky_image</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.preview">preview() (inkycal.modules.inky_image.Inkyimage static method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.remove_alpha">remove_alpha() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
<li><a href="inkycal.html#inkycal.main.Inkycal.remove_module">remove_module() (inkycal.main.Inkycal class method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.display.display.Display.render">render() (inkycal.display.display.Display method)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.resize">resize() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
<li><a href="inkycal.html#inkycal.main.Inkycal.run">run() (inkycal.main.Inkycal method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.show_events">show_events() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.modules.ical_parser.iCalendar.sort">sort() (inkycal.modules.ical_parser.iCalendar method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.main.Inkycal.test">test() (inkycal.main.Inkycal method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.custom.functions.text_wrap">text_wrap() (in module inkycal.custom.functions)</a>
</li>
<li><a href="inkycal.html#inkycal.modules.inky_image.Inkyimage.to_palette">to_palette() (inkycal.modules.inky_image.Inkyimage method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="inkycal.html#inkycal.custom.functions.write">write() (in module inkycal.custom.functions)</a>
</li>
</ul></td>
</tr></table>
</div>