From 7c6d3cec034304d0c7a91e3e2a9cd11008f73962 Mon Sep 17 00:00:00 2001
From: github-actions <actions@github.com>
Date: Thu, 7 Dec 2023 21:46:48 +0000
Subject: [PATCH] update docs [bot]

---
 docs/_sources/inkycal.rst.txt |  14 +++-
 docs/about.html               |   3 +-
 docs/dev_doc.html             |   3 +-
 docs/genindex.html            |  33 +++------
 docs/index.html               |   9 +--
 docs/inkycal.html             | 134 ++++++----------------------------
 docs/objects.inv              | Bin 666 -> 632 bytes
 docs/py-modindex.html         |   5 +-
 docs/quickstart.html          |   3 +-
 docs/search.html              |   3 +-
 docs/searchindex.js           |   2 +-
 11 files changed, 61 insertions(+), 148 deletions(-)

diff --git a/docs/_sources/inkycal.rst.txt b/docs/_sources/inkycal.rst.txt
index 49255c7..fcdc398 100644
--- a/docs/_sources/inkycal.rst.txt
+++ b/docs/_sources/inkycal.rst.txt
@@ -9,9 +9,21 @@ Inkycal
 
 Display
 ===========================
-.. automodule:: inkycal.display.display
+.. automodule:: inkycal.display.Display
   :members:
 
+
+Modules
+===========================
+Agenda
+.. automodule:: inkycal.modules.inkycal_agenda.Agenda
+  :members:
+
+Calendar
+.. automodule:: inkycal.modules.inkycal_calendar.Calendar
+  :members:
+
+
 Custom functions
 ===========================
 .. automodule:: inkycal.custom.functions
diff --git a/docs/about.html b/docs/about.html
index dabd3be..71bc234 100644
--- a/docs/about.html
+++ b/docs/about.html
@@ -48,7 +48,8 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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 current"><a class="current reference internal" href="#">About Inkycal</a></li>
diff --git a/docs/dev_doc.html b/docs/dev_doc.html
index 41a9bb0..d261641 100644
--- a/docs/dev_doc.html
+++ b/docs/dev_doc.html
@@ -47,7 +47,8 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
diff --git a/docs/genindex.html b/docs/genindex.html
index 354a310..d4be032 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -45,7 +45,8 @@
               <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
@@ -112,16 +113,12 @@
 <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><a href="inkycal.html#inkycal.main.Inkycal.calibrate">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>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <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>
@@ -131,10 +128,6 @@
 
 <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>
@@ -152,16 +145,12 @@
 <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 class 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>
+      <li><a href="inkycal.html#inkycal.custom.functions.get_fonts">get_fonts() (in module inkycal.custom.functions)</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>
@@ -186,10 +175,10 @@
 </li>
       </ul></li>
       <li>
-    inkycal.display.display
+    inkycal.display.Display
 
       <ul>
-        <li><a href="inkycal.html#module-inkycal.display.display">module</a>
+        <li><a href="inkycal.html#module-inkycal.display.Display">module</a>
 </li>
       </ul></li>
       <li>
@@ -247,7 +236,7 @@
       <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><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>
@@ -271,8 +260,6 @@
 <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.display.display.Display.render">render() (inkycal.display.display.Display method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
diff --git a/docs/index.html b/docs/index.html
index ebd979c..a193902 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -47,7 +47,8 @@
               <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
@@ -89,10 +90,8 @@
 <li class="toctree-l2"><a class="reference internal" href="inkycal.html#inkycal.main.Inkycal"><code class="docutils literal notranslate"><span class="pre">Inkycal</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.display.display">Display</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="inkycal.html#inkycal.display.display.Display"><code class="docutils literal notranslate"><span class="pre">Display</span></code></a></li>
-</ul>
-</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#modules">Modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.custom.functions">Custom functions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="inkycal.html#inkycal.custom.functions.auto_fontsize"><code class="docutils literal notranslate"><span class="pre">auto_fontsize()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="inkycal.html#inkycal.custom.functions.draw_border"><code class="docutils literal notranslate"><span class="pre">draw_border()</span></code></a></li>
diff --git a/docs/inkycal.html b/docs/inkycal.html
index 54e3742..eb29089 100644
--- a/docs/inkycal.html
+++ b/docs/inkycal.html
@@ -57,16 +57,8 @@
 </li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="#module-inkycal.display.display">Display</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#inkycal.display.display.Display"><code class="docutils literal notranslate"><span class="pre">Display</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.calibrate"><code class="docutils literal notranslate"><span class="pre">Display.calibrate()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.get_display_names"><code class="docutils literal notranslate"><span class="pre">Display.get_display_names()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.get_display_size"><code class="docutils literal notranslate"><span class="pre">Display.get_display_size()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#inkycal.display.display.Display.render"><code class="docutils literal notranslate"><span class="pre">Display.render()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="#module-inkycal.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="#modules">Modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#module-inkycal.custom.functions">Custom functions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#inkycal.custom.functions.auto_fontsize"><code class="docutils literal notranslate"><span class="pre">auto_fontsize()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#inkycal.custom.functions.draw_border"><code class="docutils literal notranslate"><span class="pre">draw_border()</span></code></a></li>
@@ -191,14 +183,9 @@ checks if the images could be generated correctly.</p>
 </dd></dl>
 
 </section>
-<section id="module-inkycal.display.display">
-<span id="display"></span><h1>Display<a class="headerlink" href="#module-inkycal.display.display" title="Link to this heading"></a></h1>
-<p>Inkycal ePaper driving functions
-Copyright by aceisace</p>
-<dl class="py class">
-<dt class="sig sig-object py" id="inkycal.display.display.Display">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">inkycal.display.display.</span></span><span class="sig-name descname"><span class="pre">Display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">epaper_model</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display" title="Link to this definition"></a></dt>
-<dd><p>Display class for inkycal</p>
+<section id="module-inkycal.display.Display">
+<span id="display"></span><h1>Display<a class="headerlink" href="#module-inkycal.display.Display" title="Link to this heading"></a></h1>
+<p>Display class for inkycal</p>
 <p>Creates an instance of the driver for the selected E-Paper model and allows
 rendering images and calibrating the E-Paper display</p>
 <dl class="simple">
@@ -207,102 +194,25 @@ rendering images and calibrating the E-Paper display</p>
 </ul>
 </dd>
 </dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="inkycal.display.display.Display.calibrate">
-<span class="sig-name descname"><span class="pre">calibrate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display.calibrate" title="Link to this definition"></a></dt>
-<dd><p>Calibrates the display to retain crisp colours</p>
-<p>Flushes the selected display several times with it’s supported colours,
-removing any previous effects of ghosting.</p>
-<dl class="simple">
-<dt>Args:</dt><dd><ul class="simple">
-<li><p>cycles: -&gt; int. The number of times to flush the display with it’s
-supported colours.</p></li>
-</ul>
-</dd>
+</section>
+<section id="modules">
+<h1>Modules<a class="headerlink" href="#modules" title="Link to this heading"></a></h1>
+<p>Agenda
+.. automodule:: inkycal.modules.inkycal_agenda.Agenda</p>
+<blockquote>
+<div><dl class="field-list simple">
+<dt class="field-odd">members<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p></dd>
 </dl>
-<p>It’s recommended to calibrate the display after every 6 display updates
-for best results. For black-white only displays, calibration is less
-critical, but not calibrating regularly results in grey-ish text.</p>
-<p>Please note that calibration takes a while to complete. 3 cycles may
-take 10 minutes on black-white E-Papers while it takes 20 minutes on coloured
-E-Paper displays.</p>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="inkycal.display.display.Display.get_display_names">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_display_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#inkycal.display.display.Display.get_display_names" title="Link to this definition"></a></dt>
-<dd><p>Prints all supported E-Paper models.</p>
-<p>Fetches all filenames in driver folder and prints them on the console.</p>
-<dl class="simple">
-<dt>Returns:</dt><dd><p>Printed version of all supported Displays.</p>
-</dd>
+</div></blockquote>
+<p>Calendar
+.. automodule:: inkycal.modules.inkycal_calendar.Calendar</p>
+<blockquote>
+<div><dl class="field-list simple">
+<dt class="field-odd">members<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p></dd>
 </dl>
-<p>Use one of the models to intilialize the Display class in order to gain
-access to the E-Paper.</p>
-<p>You can use this function directly without creating the Display class:</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Display</span><span class="o">.</span><span class="n">get_display_names</span><span class="p">()</span>
-</pre></div>
-</div>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="inkycal.display.display.Display.get_display_size">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_display_size</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model_name)</span> <span class="pre">-&gt;</span> <span class="pre">(&lt;class</span> <span class="pre">'int'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;class</span> <span class="pre">'int'&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#inkycal.display.display.Display.get_display_size" title="Link to this definition"></a></dt>
-<dd><p>Returns the size of the display as a tuple -&gt; (width, height)</p>
-<p>Looks inside “drivers” folder for the given model name, then returns it’s
-size.</p>
-<dl class="simple">
-<dt>Args:</dt><dd><ul class="simple">
-<li><p>model_name: str -&gt; The name of the E-Paper display to get it’s size.</p></li>
-</ul>
-</dd>
-<dt>Returns:</dt><dd><p>(width, height) -&gt;tuple, showing the size of the display</p>
-</dd>
-</dl>
-<p>You can use this function directly without creating the Display class:</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Display</span><span class="o">.</span><span class="n">get_display_size</span><span class="p">(</span><span class="s1">&#39;model_name&#39;</span><span class="p">)</span>
-</pre></div>
-</div>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="inkycal.display.display.Display.render">
-<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">im_black:</span> <span class="pre">&lt;module</span> <span class="pre">'PIL.Image'</span> <span class="pre">from</span> <span class="pre">'/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">im_colour:</span> <span class="pre">&lt;module</span> <span class="pre">'PIL.Image'</span> <span class="pre">from</span> <span class="pre">'/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'&gt;</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#inkycal.display.display.Display.render" title="Link to this definition"></a></dt>
-<dd><p>Renders an image on the selected E-Paper display.</p>
-<p>Initlializes the E-Paper display, sends image data and executes command
-to update the display.</p>
-<dl class="simple">
-<dt>Args:</dt><dd><ul class="simple">
-<li><p>im_black: The image for the black-pixels. Anything in this image that is
-black is rendered as black on the display. This is required and ideally
-should be a black-white image.</p></li>
-<li><p>im_colour: For E-Paper displays supporting colour, a separate image,
-ideally black-white is required for the coloured pixels. Anything that is
-black in this image will show up as either red/yellow.</p></li>
-</ul>
-</dd>
-</dl>
-<p>Rendering an image for black-white E-Paper displays:</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">sample_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;path/to/file.png&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">display</span> <span class="o">=</span> <span class="n">Display</span><span class="p">(</span><span class="s1">&#39;my_black_white_display&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">display</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">sample_image</span><span class="p">)</span>
-</pre></div>
-</div>
-<p>Rendering black-white on coloured E-Paper displays:
-&gt;&gt;&gt; sample_image = Image.open(‘path/to/file.png’)
-&gt;&gt;&gt; display = Display(‘my_coloured_display’)
-&gt;&gt;&gt; display.render(sample_image, sample_image)</p>
-<p>Rendering coloured image where 2 images are available:</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">black_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;path/to/file.png&#39;</span><span class="p">)</span> <span class="c1"># black pixels</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">colour_image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;path/to/file.png&#39;</span><span class="p">)</span> <span class="c1"># coloured pixels</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">display</span> <span class="o">=</span> <span class="n">Display</span><span class="p">(</span><span class="s1">&#39;my_coloured_display&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">display</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">black_image</span><span class="p">,</span> <span class="n">colour_image</span><span class="p">)</span>
-</pre></div>
-</div>
-</dd></dl>
-
-</dd></dl>
-
+</div></blockquote>
 </section>
 <section id="module-inkycal.custom.functions">
 <span id="custom-functions"></span><h1>Custom functions<a class="headerlink" href="#module-inkycal.custom.functions" title="Link to this heading"></a></h1>
diff --git a/docs/objects.inv b/docs/objects.inv
index 70abe1dc20765dee2ba0a05b617ba5a0e7f06f8d..97338b16590beb2fa0ac7ba3a2b019e554eb5ea3 100644
GIT binary patch
delta 523
zcmV+m0`&cw1^5Jzcz<r&Fbv1<ehLHIHO6}FZCEco4Ct^25EzS&h3ab(W!HWB$(HkB
ztV<n7haeHj|IZXdS`zwos6keB@MKig1YMIb+Lv~CRE7tM<+oDIK`klyC0Tc0%UvP<
zBd#EjVU5w`#XF9uqpN&a!md)dgP!e;<LEXs4oE4Hy9j>pgnx?B`(}#Jgic2kbRZ<`
z<@T}=z7gvk*v*9A30nPpF1(d6R8Q&qrp8bp^v#0mIW0zEEy4S1*<A{%_z`;tX>SUt
zHGI9+1WnxZdV|)5Eh<7!D`iumViUy$v*3Ihi1k(dS6_)AAW?I0>&kqMP=S<;&#kd#
zGZ&~@A~=Q}&VM6&FK?XQytKu;;9j6Kz**yrVvUfPjToHF!Sb!?Ggi+VcWcAPH4_RB
zxUJt$@@eQ!p!Mzk0bn}Z8Y%47tz4j{ZqLBUl+M^Y888an0W)x{!%kqIf#gt`4jD+>
zLKfWdUUMfX-jZyb4*KlGg1re;dg71V)aCA>oD7q{{C__A=0m06*s(F@B6c>V=%+Z&
z(%5)_L{m_4v|+pe6bIBob9|eG@qU7Glpd`~`#k<E&S5iu5s^;rC41h^QghznDfd{a
z4|1@>?&wJ2KhtX<Wpm;EMD{Yo>guKXPZ0I1Cvc16o~=pw>$EO>oY%TtJ}KE!=<noz
NiGObK7X&D+9772x4JZHr

delta 557
zcmV+|0@D5X1eyhqcz<%6Fc8P@JOwlD)l75Et<zj`=u9$w0L>aLMiYHi5)ktA6$or-
zQyXNRZ0+v<hqT(2#N=CF0x!zOIwgv#k)>lw+FbXKLeYj}{w-%yQ0)Z&60C=>`5|Nf
z5f{)nMJgqoWgj@8W>@~OhFzsl106XkL(xPtPUyl!?jqRUI)4<zeMD23bZDeUK?{t-
zk;kXS;kzT90Ub@~40D^mPnp#m`uTTPVf>{no-T}%gS9)pJ8KK?V@CsF0RmmEXbfi9
z*2zXB2(;;NbJ54s49cnKZ!-iixocAfLGc_0n|5L;*qi>fRyER5)yW90X<}3kt=lLY
z6XhG#4~Pb1r+@r!&g#GVg8cyQcM{CDG+!eWz&W8)`^79~fhswIA=u({EZ)l-YCkP)
zb>7|!<O(RMj1r_`9Fq|n!&9(qt-6HSv&!r(ct0jgzzO5({VX4w?hM*q?w<h02Sml0
zj$O(EHCB59PNL}ywUYoN(3~&<M;mMzb_qxZg=&!i*MBu6!EL`ruY&wbRQv95w{9#r
zs>bEk(MPJv{P2*EhS8sYAAQrMl2L5Q5VMG#Od<Now=-ATUm)Jp2;bT;JhHMAO6KqN
z_fhEIfXD~wYz^Ay;cs>coA|4UaC5KO({k3D%L>nP_o@114!S?gju8Gc90OrC3-1lt
vOYgHQ*Cy)U4J+TQ1G7r*#Tt~a=W%9zzn1m-OTiXGe+B=G-`wmE1#X?j-=Y$K

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 137527f..193b566 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -48,7 +48,8 @@
               <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
@@ -104,7 +105,7 @@
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="inkycal.html#module-inkycal.display.display"><code class="xref">inkycal.display.display</code></a></td><td>
+       <a href="inkycal.html#module-inkycal.display.Display"><code class="xref">inkycal.display.Display</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
diff --git a/docs/quickstart.html b/docs/quickstart.html
index 77ce19b..8b84d6e 100644
--- a/docs/quickstart.html
+++ b/docs/quickstart.html
@@ -48,7 +48,8 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
diff --git a/docs/search.html b/docs/search.html
index 63f731d..5a4105f 100644
--- a/docs/search.html
+++ b/docs/search.html
@@ -48,7 +48,8 @@
               <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.display.Display">Display</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inkycal.html#modules">Modules</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="about.html">About Inkycal</a></li>
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 7eef4b8..4a73f67 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["about", "dev_doc", "index", "inkycal", "quickstart"], "filenames": ["about.md", "dev_doc.md", "index.rst", "inkycal.rst", "quickstart.md"], "titles": ["About Inkycal", "Developer documentation", "Inkycal documentation", "Inkycal", "Quickstart"], "terms": {"i": [0, 1, 3], "python3": [0, 3], "softwar": 0, "select": [0, 3], "e": [0, 3, 4], "paper": [0, 3], "displai": [0, 2], "It": [0, 3], "": [0, 3], "open": [0, 3], "sourc": 0, "non": [0, 3], "commerci": 0, "fulli": 0, "modular": 0, "user": 0, "friendli": 0, "even": 0, "run": [0, 3], "well": 0, "raspberri": [0, 4], "pi": [0, 3, 4], "zero": 0, "ha": [0, 3], "web": [0, 4], "ui": [0, 4], "which": [0, 3], "take": [0, 3], "care": [0, 3], "ad": 0, "your": [0, 3, 4], "detail": 0, "No": 0, "more": [0, 3, 4], "edit": 0, "file": [0, 2, 3], "yai": 0, "parti": [0, 1], "_": 0, "face": 0, "The": [0, 3], "main": [0, 3], "idea": 0, "behind": 0, "wa": [0, 3], "creat": [0, 1, 2, 3], "dashboard": 0, "blend": 0, "its": 0, "environ": 0, "show": [0, 3], "you": [0, 3], "all": [0, 3], "inform": 0, "without": [0, 3], "have": [0, 3], "look": [0, 3], "them": [0, 3], "up": [0, 3], "sever": [0, 3], "built": 0, "modul": [0, 1, 2, 3], "help": 0, "stai": 0, "organis": 0, "provid": 0, "weather": 0, "forecast": 0, "full": [0, 3], "week": 0, "next": [0, 3], "few": 0, "hour": 0, "get": [0, 3], "latest": [0, 3], "new": [0, 3], "from": [0, 3], "atom": 0, "rss": 0, "feed": 0, "icalendar": [0, 2, 3], "agenda": 0, "mai": [0, 3], "synchronis": 0, "phone": 0, "monthli": 0, "calendar": 0, "also": 0, "event": [0, 3], "sync": 0, "googl": [0, 3], "etc": 0, "fetch": [0, 3], "some": 0, "joke": 0, "form": 0, "smile": 0, "what": 0, "compat": 0, "third": [0, 1], "someth": [0, 3], "miss": 0, "can": [0, 3], "write": [0, 2, 3], "own": 0, "share": 0, "commun": 0, "discord": 0, "case": 0, "re": 0, "pinch": 0, "set": [0, 2, 3], "noob": 0, "welcom": 0, "too": 0, "cours": 0, "develop": [0, 2], "mainli": [0, 1], "aceisac": [0, 3], "univers": 0, "student": 0, "other": [0, 3], "free": 0, "time": [0, 3], "mean": 0, "we": 0, "work": [0, 3], "noth": 0, "doesn": [0, 3], "t": [0, 3], "don": 0, "need": 0, "anyth": [0, 3], "invest": 0, "larg": 0, "amount": 0, "effort": 0, "coffe": 0, "pleas": [0, 3, 4], "support": [0, 3], "via": [0, 4], "donat": 0, "u": 0, "keep": 0, "thi": [0, 1, 3], "project": [0, 3], "aliv": 0, "thank": 0, "who": 1, "wish": 1, "custom": 2, "function": 2, "auto_fonts": [2, 3], "draw_bord": [2, 3], "get_font": [2, 3], "get_system_tz": [2, 3], "internet_avail": [2, 3], "text_wrap": [2, 3], "helper": 2, "class": 2, "inkyimag": [2, 3], "about": 2, "quickstart": 2, "instal": 2, "index": 2, "search": [2, 3], "page": 2, "copyright": 3, "aceinnolab": [3, 4], "settings_path": 3, "str": 3, "none": 3, "render": 3, "bool": 3, "true": 3, "test": 3, "program": 3, "arg": 3, "path": 3, "json": 3, "given": 3, "tri": 3, "boot": 3, "folder": [3, 4], "fals": 3, "imag": 3, "epap": 3, "attribut": 3, "optim": 3, "reduc": 3, "number": 3, "colour": 3, "gener": [3, 4], "improv": 3, "9": 3, "7": 3, "calibr": 3, "us": 3, "default": 3, "3": 3, "cycl": 3, "after": 3, "refresh": 3, "shown": 3, "countdown": 3, "interval_min": 3, "return": 3, "remain": 3, "second": 3, "until": 3, "updat": 3, "async": 3, "nonstop": 3, "mode": 3, "an": 3, "infin": 3, "loop": 3, "assembl": 3, "one": 3, "sleep": 3, "schedul": 3, "issu": 3, "attempt": 3, "import": 3, "name": 3, "load": 3, "config": 3, "each": 3, "initi": 3, "check": 3, "could": 3, "correctli": 3, "found": 3, "drive": 3, "epaper_model": 3, "instanc": 3, "driver": 3, "model": 3, "allow": 3, "retain": 3, "crisp": 3, "flush": 3, "remov": 3, "ani": 3, "previou": 3, "effect": 3, "ghost": 3, "int": 3, "recommend": 3, "everi": 3, "6": 3, "best": 3, "result": 3, "For": 3, "black": 3, "white": 3, "onli": 3, "less": 3, "critic": 3, "regularli": 3, "grei": 3, "ish": 3, "text": 3, "note": 3, "while": 3, "complet": 3, "10": 3, "minut": 3, "20": 3, "classmethod": 3, "get_display_nam": 3, "list": 3, "print": 3, "filenam": 3, "consol": 3, "version": 3, "intili": 3, "order": 3, "gain": 3, "access": 3, "directli": [3, 4], "get_display_s": 3, "model_nam": 3, "size": 3, "tupl": 3, "width": 3, "height": 3, "insid": 3, "im_black": 3, "pil": 3, "home": 3, "runner": 3, "venv": 3, "lib": 3, "11": 3, "site": 3, "packag": 3, "py": 3, "im_colour": 3, "initli": 3, "send": 3, "data": 3, "execut": 3, "command": 3, "pixel": 3, "requir": 3, "ideal": 3, "should": 3, "separ": 3, "either": 3, "red": 3, "yellow": 3, "sample_imag": 3, "png": 3, "my_black_white_displai": 3, "my_coloured_displai": 3, "where": 3, "2": 3, "ar": 3, "avail": 3, "black_imag": 3, "colour_imag": 3, "eas": 3, "font": 3, "max_height": 3, "scale": 3, "80": 3, "fill": 3, "A": 3, "object": 3, "integ": 3, "repres": 3, "adjust": 3, "modifi": 3, "xy": 3, "radiu": 3, "5": 3, "thick": 3, "1": 3, "shrinkag": 3, "0": 3, "draw": 3, "border": 3, "coordin": 3, "drawn": 3, "usual": 3, "top": 3, "left": 3, "corner": 3, "g": 3, "32": 3, "100": 3, "x": 3, "co": 3, "ordin": 3, "y": 3, "plain": 3, "rectangl": 3, "round": 3, "contain": 3, "decim": 3, "present": 3, "percentag": 3, "shrink": 3, "width_shrink_percentag": 3, "height_shrink_percentag": 3, "output": 3, "To": 3, "fontfil": 3, "dictionari": 3, "fontnam": 3, "follow": 3, "sytax": 3, "imagefont": 3, "truetyp": 3, "system": 3, "timezon": 3, "extract": 3, "local": 3, "instead": 3, "utc": 3, "arrow": 3, "now": 3, "awar": 3, "tz": 3, "internet": 3, "connect": 3, "com": [3, 4], "timeout": 3, "network": 3, "reach": 3, "establish": 3, "add": 3, "do": 3, "max_width": 3, "split": 3, "veri": 3, "long": 3, "smaller": 3, "part": 3, "line": 3, "fit": 3, "accur": 3, "calcul": 3, "string": 3, "defin": 3, "maximum": 3, "befor": 3, "chunk": 3, "box_siz": 3, "kwarg": 3, "posit": 3, "specifi": 3, "box": 3, "actual": 3, "option": 3, "align": 3, "center": 3, "right": 3, "autofit": 3, "automat": 3, "increas": 3, "fontsiz": 3, "much": 3, "possibl": 3, "chang": 3, "caus": 3, "rotat": 3, "angl": 3, "anti": 3, "clockwis": 3, "fill_width": 3, "90": 3, "fill_height": 3, "pars": 3, "ical_pars": 3, "moudul": 3, "url": 3, "static": 3, "all_dai": 3, "dai": 3, "els": 3, "clear_ev": 3, "clear": 3, "previous": 3, "get_ev": 3, "timeline_start": 3, "timeline_end": 3, "input": 3, "begin": 3, "timelin": 3, "end": 3, "format": 3, "sort": 3, "date": 3, "load_from_fil": 3, "filepath": 3, "valid": 3, "exampl": 3, "path1": 3, "singl": 3, "OR": 3, "path2": 3, "multipl": 3, "raw": 3, "load_url": 3, "usernam": 3, "password": 3, "url1": 3, "url2": 3, "protect": 3, "show_ev": 3, "fmt": 3, "dd": 3, "mmm": 3, "yy": 3, "hh": 3, "mm": 3, "readabl": 3, "wai": 3, "paramet": 3, "see": 3, "http": [3, 4], "readthedoc": 3, "io": 3, "en": 3, "token": 3, "info": 3, "handl": 3, "made": 3, "inky_imag": 3, "imga": 3, "written": 3, "commonli": 3, "oper": 3, "autoflip": 3, "layout": 3, "flip": 3, "choos": 3, "horizont": 3, "vertic": 3, "In": 3, "greater": 3, "than": 3, "current": 3, "save": 3, "180": 3, "270": 3, "360": 3, "sampl": 3, "logo": 3, "download": [3, 4], "nice_p": 3, "rais": 3, "filenotfounderror": 3, "except": 3, "when": 3, "oserror": 3, "point": 3, "correct": 3, "typeerror": 3, "start": 3, "htpp": 3, "merg": 3, "image1": 3, "image2": 3, "two": 3, "replac": 3, "first": 3, "transpar": 3, "ones": 3, "Then": 3, "past": 3, "rgba": 3, "preview": 3, "gpicview": 3, "rapsbian": 3, "desktop": 3, "remove_alpha": 3, "alpha": 3, "band": 3, "resiz": 3, "desir": 3, "to_palett": 3, "palett": 3, "dither": 3, "map": 3, "below": 3, "solid": 3, "valueerror": 3, "bwr": 3, "bwy": 3, "bw": 3, "github": 4, "repo": 4, "clone": 4, "git": 4, "go": 4, "cd": 4, "pip3": 4, "navig": 4, "copi": 4, "come": 4, "soon": 4}, "objects": {"inkycal.custom": [[3, 0, 0, "-", "functions"]], "inkycal.custom.functions": [[3, 1, 1, "", "auto_fontsize"], [3, 1, 1, "", "draw_border"], [3, 1, 1, "", "get_fonts"], [3, 1, 1, "", "get_system_tz"], [3, 1, 1, "", "internet_available"], [3, 1, 1, "", "text_wrap"], [3, 1, 1, "", "write"]], "inkycal.display": [[3, 0, 0, "-", "display"]], "inkycal.display.display": [[3, 2, 1, "", "Display"]], "inkycal.display.display.Display": [[3, 3, 1, "", "calibrate"], [3, 3, 1, "", "get_display_names"], [3, 3, 1, "", "get_display_size"], [3, 3, 1, "", "render"]], "inkycal": [[3, 0, 0, "-", "main"]], "inkycal.main": [[3, 2, 1, "", "Inkycal"]], "inkycal.main.Inkycal": [[3, 3, 1, "", "calibrate"], [3, 3, 1, "", "countdown"], [3, 3, 1, "", "run"], [3, 3, 1, "", "test"]], "inkycal.modules": [[3, 0, 0, "-", "ical_parser"], [3, 0, 0, "-", "inky_image"]], "inkycal.modules.ical_parser": [[3, 2, 1, "", "iCalendar"]], "inkycal.modules.ical_parser.iCalendar": [[3, 3, 1, "", "all_day"], [3, 3, 1, "", "clear_events"], [3, 3, 1, "", "get_events"], [3, 3, 1, "", "get_system_tz"], [3, 3, 1, "", "load_from_file"], [3, 3, 1, "", "load_url"], [3, 3, 1, "", "show_events"], [3, 3, 1, "", "sort"]], "inkycal.modules.inky_image": [[3, 2, 1, "", "Inkyimage"]], "inkycal.modules.inky_image.Inkyimage": [[3, 3, 1, "", "autoflip"], [3, 3, 1, "", "clear"], [3, 3, 1, "", "flip"], [3, 3, 1, "", "load"], [3, 3, 1, "", "merge"], [3, 3, 1, "", "preview"], [3, 3, 1, "", "remove_alpha"], [3, 3, 1, "", "resize"], [3, 3, 1, "", "to_palette"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"about": 0, "inkyc": [0, 2, 3, 4], "develop": 1, "document": [1, 2], "content": 2, "indic": 2, "tabl": 2, "displai": 3, "custom": 3, "function": 3, "helper": 3, "class": 3, "quickstart": 4, "instal": 4, "creat": 4, "set": 4, "file": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"About Inkycal": [[0, "about-inkycal"]], "Developer documentation": [[1, "developer-documentation"]], "Inkycal documentation": [[2, "inkycal-documentation"]], "Contents:": [[2, null]], "Indices and tables": [[2, "indices-and-tables"]], "Inkycal": [[3, "module-inkycal.main"]], "Display": [[3, "module-inkycal.display.display"]], "Custom functions": [[3, "module-inkycal.custom.functions"]], "Helper classes": [[3, "module-inkycal.modules.ical_parser"]], "Quickstart": [[4, "quickstart"]], "Installing Inkycal": [[4, "installing-inkycal"]], "Creating settings file": [[4, "creating-settings-file"]]}, "indexentries": {"display (class in inkycal.display.display)": [[3, "inkycal.display.display.Display"]], "inkycal (class in inkycal.main)": [[3, "inkycal.main.Inkycal"]], "inkyimage (class in inkycal.modules.inky_image)": [[3, "inkycal.modules.inky_image.Inkyimage"]], "all_day() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.all_day"]], "auto_fontsize() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.auto_fontsize"]], "autoflip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.autoflip"]], "calibrate() (inkycal.display.display.display method)": [[3, "inkycal.display.display.Display.calibrate"]], "calibrate() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.calibrate"]], "clear() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.clear"]], "clear_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.clear_events"]], "countdown() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.countdown"]], "draw_border() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.draw_border"]], "flip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.flip"]], "get_display_names() (inkycal.display.display.display class method)": [[3, "inkycal.display.display.Display.get_display_names"]], "get_display_size() (inkycal.display.display.display class method)": [[3, "inkycal.display.display.Display.get_display_size"]], "get_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_events"]], "get_fonts() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_fonts"]], "get_system_tz() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_system_tz"]], "get_system_tz() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_system_tz"]], "icalendar (class in inkycal.modules.ical_parser)": [[3, "inkycal.modules.ical_parser.iCalendar"]], "inkycal.custom.functions": [[3, "module-inkycal.custom.functions"]], "inkycal.display.display": [[3, "module-inkycal.display.display"]], "inkycal.main": [[3, "module-inkycal.main"]], "inkycal.modules.ical_parser": [[3, "module-inkycal.modules.ical_parser"]], "inkycal.modules.inky_image": [[3, "module-inkycal.modules.inky_image"]], "internet_available() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.internet_available"]], "load() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.load"]], "load_from_file() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_from_file"]], "load_url() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_url"]], "merge() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.merge"]], "module": [[3, "module-inkycal.custom.functions"], [3, "module-inkycal.display.display"], [3, "module-inkycal.main"], [3, "module-inkycal.modules.ical_parser"], [3, "module-inkycal.modules.inky_image"]], "preview() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.preview"]], "remove_alpha() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.remove_alpha"]], "render() (inkycal.display.display.display method)": [[3, "inkycal.display.display.Display.render"]], "resize() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.resize"]], "run() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.run"]], "show_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.show_events"]], "sort() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.sort"]], "test() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.test"]], "text_wrap() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.text_wrap"]], "to_palette() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.to_palette"]], "write() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.write"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["about", "dev_doc", "index", "inkycal", "quickstart"], "filenames": ["about.md", "dev_doc.md", "index.rst", "inkycal.rst", "quickstart.md"], "titles": ["About Inkycal", "Developer documentation", "Inkycal documentation", "Inkycal", "Quickstart"], "terms": {"i": [0, 1, 3], "python3": [0, 3], "softwar": 0, "select": [0, 3], "e": [0, 3, 4], "paper": [0, 3], "displai": [0, 2], "It": 0, "": [0, 3], "open": 0, "sourc": 0, "non": [0, 3], "commerci": 0, "fulli": 0, "modular": 0, "user": 0, "friendli": 0, "even": 0, "run": [0, 3], "well": 0, "raspberri": [0, 4], "pi": [0, 3, 4], "zero": 0, "ha": [0, 3], "web": [0, 4], "ui": [0, 4], "which": [0, 3], "take": [0, 3], "care": [0, 3], "ad": 0, "your": [0, 3, 4], "detail": 0, "No": 0, "more": [0, 3, 4], "edit": 0, "file": [0, 2, 3], "yai": 0, "parti": [0, 1], "_": 0, "face": 0, "The": [0, 3], "main": [0, 3], "idea": 0, "behind": 0, "wa": [0, 3], "creat": [0, 1, 2, 3], "dashboard": 0, "blend": 0, "its": 0, "environ": 0, "show": [0, 3], "you": 0, "all": [0, 3], "inform": 0, "without": [0, 3], "have": [0, 3], "look": [0, 3], "them": [0, 3], "up": 0, "sever": 0, "built": 0, "modul": [0, 1, 2], "help": 0, "stai": 0, "organis": 0, "provid": 0, "weather": 0, "forecast": 0, "full": [0, 3], "week": 0, "next": [0, 3], "few": 0, "hour": 0, "get": [0, 3], "latest": [0, 3], "new": [0, 3], "from": [0, 3], "atom": 0, "rss": 0, "feed": 0, "icalendar": [0, 2, 3], "agenda": [0, 3], "mai": 0, "synchronis": 0, "phone": 0, "monthli": 0, "calendar": [0, 3], "also": 0, "event": [0, 3], "sync": 0, "googl": [0, 3], "etc": 0, "fetch": 0, "some": 0, "joke": 0, "form": 0, "smile": 0, "what": 0, "compat": 0, "third": [0, 1], "someth": [0, 3], "miss": 0, "can": [0, 3], "write": [0, 2, 3], "own": 0, "share": 0, "commun": 0, "discord": 0, "case": 0, "re": 0, "pinch": 0, "set": [0, 2, 3], "noob": 0, "welcom": 0, "too": 0, "cours": 0, "develop": [0, 2], "mainli": [0, 1], "aceisac": 0, "univers": 0, "student": 0, "other": [0, 3], "free": 0, "time": [0, 3], "mean": 0, "we": 0, "work": [0, 3], "noth": 0, "doesn": [0, 3], "t": [0, 3], "don": 0, "need": 0, "anyth": 0, "invest": 0, "larg": 0, "amount": 0, "effort": 0, "coffe": 0, "pleas": [0, 4], "support": [0, 3], "via": [0, 4], "donat": 0, "u": 0, "keep": 0, "thi": [0, 1, 3], "project": [0, 3], "aliv": 0, "thank": 0, "who": 1, "wish": 1, "custom": 2, "function": 2, "auto_fonts": [2, 3], "draw_bord": [2, 3], "get_font": [2, 3], "get_system_tz": [2, 3], "internet_avail": [2, 3], "text_wrap": [2, 3], "helper": 2, "class": 2, "inkyimag": [2, 3], "about": 2, "quickstart": 2, "instal": 2, "index": 2, "search": [2, 3], "page": 2, "copyright": 3, "aceinnolab": [3, 4], "settings_path": 3, "str": 3, "none": 3, "render": 3, "bool": 3, "true": 3, "test": 3, "program": 3, "arg": 3, "path": 3, "json": 3, "given": 3, "tri": 3, "boot": 3, "folder": [3, 4], "fals": 3, "imag": 3, "epap": 3, "attribut": 3, "optim": 3, "reduc": 3, "number": 3, "colour": 3, "gener": [3, 4], "improv": 3, "9": 3, "7": 3, "calibr": 3, "us": 3, "default": 3, "3": 3, "cycl": 3, "after": 3, "refresh": 3, "shown": 3, "countdown": 3, "interval_min": 3, "return": 3, "remain": 3, "second": 3, "until": 3, "updat": 3, "async": 3, "nonstop": 3, "mode": 3, "an": 3, "infin": 3, "loop": 3, "assembl": 3, "one": 3, "sleep": 3, "schedul": 3, "issu": 3, "attempt": 3, "import": 3, "name": 3, "load": 3, "config": 3, "each": 3, "initi": 3, "check": 3, "could": 3, "correctli": 3, "found": 3, "instanc": 3, "driver": 3, "model": 3, "allow": 3, "epaper_model": 3, "automodul": 3, "inkycal_agenda": 3, "member": 3, "inkycal_calendar": 3, "eas": 3, "font": 3, "max_height": 3, "scale": 3, "80": 3, "height": 3, "fill": 3, "A": 3, "pil": 3, "object": 3, "integ": 3, "repres": 3, "adjust": 3, "should": 3, "modifi": 3, "xy": 3, "size": 3, "radiu": 3, "5": 3, "thick": 3, "1": 3, "shrinkag": 3, "0": 3, "draw": 3, "border": 3, "coordin": 3, "drawn": 3, "usual": 3, "im_black": 3, "im_colour": 3, "tupl": 3, "top": 3, "left": 3, "corner": 3, "g": 3, "32": 3, "100": 3, "where": 3, "x": 3, "co": 3, "ordin": 3, "y": 3, "width": 3, "plain": 3, "rectangl": 3, "round": 3, "pixel": 3, "contain": 3, "decim": 3, "present": 3, "percentag": 3, "shrink": 3, "width_shrink_percentag": 3, "height_shrink_percentag": 3, "2": 3, "10": 3, "20": 3, "print": 3, "avail": 3, "output": 3, "To": 3, "access": 3, "fontfil": 3, "dictionari": 3, "fontnam": 3, "follow": 3, "sytax": 3, "imagefont": 3, "truetyp": 3, "system": 3, "timezon": 3, "extract": 3, "local": 3, "instead": 3, "utc": 3, "arrow": 3, "now": 3, "awar": 3, "tz": 3, "internet": 3, "connect": 3, "com": [3, 4], "timeout": 3, "network": 3, "reach": 3, "establish": 3, "add": 3, "do": 3, "requir": 3, "text": 3, "max_width": 3, "split": 3, "veri": 3, "long": 3, "smaller": 3, "part": 3, "line": 3, "fit": 3, "accur": 3, "calcul": 3, "string": 3, "int": 3, "defin": 3, "maximum": 3, "befor": 3, "chunk": 3, "list": 3, "box_siz": 3, "kwarg": 3, "posit": 3, "specifi": 3, "box": 3, "actual": 3, "option": 3, "align": 3, "center": 3, "right": 3, "autofit": 3, "automat": 3, "increas": 3, "fontsiz": 3, "much": 3, "possibl": 3, "black": 3, "chang": 3, "caus": 3, "rotat": 3, "angl": 3, "anti": 3, "clockwis": 3, "fill_width": 3, "90": 3, "fill_height": 3, "pars": 3, "ical_pars": 3, "moudul": 3, "url": 3, "static": 3, "all_dai": 3, "dai": 3, "els": 3, "clear_ev": 3, "clear": 3, "previous": 3, "get_ev": 3, "timeline_start": 3, "timeline_end": 3, "input": 3, "begin": 3, "timelin": 3, "end": 3, "format": 3, "sort": 3, "date": 3, "load_from_fil": 3, "filepath": 3, "valid": 3, "exampl": 3, "path1": 3, "singl": 3, "OR": 3, "path2": 3, "multipl": 3, "raw": 3, "load_url": 3, "usernam": 3, "password": 3, "url1": 3, "url2": 3, "protect": 3, "show_ev": 3, "fmt": 3, "dd": 3, "mmm": 3, "yy": 3, "hh": 3, "mm": 3, "readabl": 3, "wai": 3, "paramet": 3, "see": 3, "http": [3, 4], "readthedoc": 3, "io": 3, "en": 3, "token": 3, "info": 3, "order": 3, "handl": 3, "made": 3, "inky_imag": 3, "imga": 3, "written": 3, "commonli": 3, "oper": 3, "autoflip": 3, "layout": 3, "flip": 3, "choos": 3, "horizont": 3, "vertic": 3, "In": 3, "greater": 3, "than": 3, "remov": 3, "current": 3, "save": 3, "180": 3, "270": 3, "360": 3, "sampl": 3, "logo": 3, "png": 3, "home": 3, "download": [3, 4], "nice_p": 3, "rais": 3, "filenotfounderror": 3, "except": 3, "when": 3, "oserror": 3, "point": 3, "correct": 3, "typeerror": 3, "start": 3, "htpp": 3, "merg": 3, "image1": 3, "image2": 3, "two": 3, "replac": 3, "white": 3, "first": 3, "transpar": 3, "ones": 3, "Then": 3, "past": 3, "rgba": 3, "preview": 3, "gpicview": 3, "onli": 3, "rapsbian": 3, "desktop": 3, "remove_alpha": 3, "alpha": 3, "band": 3, "resiz": 3, "desir": 3, "to_palett": 3, "palett": 3, "dither": 3, "runner": 3, "venv": 3, "lib": 3, "11": 3, "site": 3, "packag": 3, "py": 3, "map": 3, "below": 3, "solid": 3, "valueerror": 3, "bwr": 3, "red": 3, "bwy": 3, "yellow": 3, "bw": 3, "directli": 4, "github": 4, "repo": 4, "clone": 4, "git": 4, "go": 4, "cd": 4, "pip3": 4, "navig": 4, "copi": 4, "come": 4, "soon": 4}, "objects": {"inkycal.custom": [[3, 0, 0, "-", "functions"]], "inkycal.custom.functions": [[3, 1, 1, "", "auto_fontsize"], [3, 1, 1, "", "draw_border"], [3, 1, 1, "", "get_fonts"], [3, 1, 1, "", "get_system_tz"], [3, 1, 1, "", "internet_available"], [3, 1, 1, "", "text_wrap"], [3, 1, 1, "", "write"]], "inkycal.display": [[3, 0, 0, "-", "Display"]], "inkycal": [[3, 0, 0, "-", "main"]], "inkycal.main": [[3, 2, 1, "", "Inkycal"]], "inkycal.main.Inkycal": [[3, 3, 1, "", "calibrate"], [3, 3, 1, "", "countdown"], [3, 3, 1, "", "run"], [3, 3, 1, "", "test"]], "inkycal.modules": [[3, 0, 0, "-", "ical_parser"], [3, 0, 0, "-", "inky_image"]], "inkycal.modules.ical_parser": [[3, 2, 1, "", "iCalendar"]], "inkycal.modules.ical_parser.iCalendar": [[3, 3, 1, "", "all_day"], [3, 3, 1, "", "clear_events"], [3, 3, 1, "", "get_events"], [3, 3, 1, "", "get_system_tz"], [3, 3, 1, "", "load_from_file"], [3, 3, 1, "", "load_url"], [3, 3, 1, "", "show_events"], [3, 3, 1, "", "sort"]], "inkycal.modules.inky_image": [[3, 2, 1, "", "Inkyimage"]], "inkycal.modules.inky_image.Inkyimage": [[3, 3, 1, "", "autoflip"], [3, 3, 1, "", "clear"], [3, 3, 1, "", "flip"], [3, 3, 1, "", "load"], [3, 3, 1, "", "merge"], [3, 3, 1, "", "preview"], [3, 3, 1, "", "remove_alpha"], [3, 3, 1, "", "resize"], [3, 3, 1, "", "to_palette"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"about": 0, "inkyc": [0, 2, 3, 4], "develop": 1, "document": [1, 2], "content": 2, "indic": 2, "tabl": 2, "displai": 3, "modul": 3, "custom": 3, "function": 3, "helper": 3, "class": 3, "quickstart": 4, "instal": 4, "creat": 4, "set": 4, "file": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"About Inkycal": [[0, "about-inkycal"]], "Developer documentation": [[1, "developer-documentation"]], "Inkycal documentation": [[2, "inkycal-documentation"]], "Contents:": [[2, null]], "Indices and tables": [[2, "indices-and-tables"]], "Inkycal": [[3, "module-inkycal.main"]], "Display": [[3, "module-inkycal.display.Display"]], "Modules": [[3, "modules"]], "Custom functions": [[3, "module-inkycal.custom.functions"]], "Helper classes": [[3, "module-inkycal.modules.ical_parser"]], "Quickstart": [[4, "quickstart"]], "Installing Inkycal": [[4, "installing-inkycal"]], "Creating settings file": [[4, "creating-settings-file"]]}, "indexentries": {"inkycal (class in inkycal.main)": [[3, "inkycal.main.Inkycal"]], "inkyimage (class in inkycal.modules.inky_image)": [[3, "inkycal.modules.inky_image.Inkyimage"]], "all_day() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.all_day"]], "auto_fontsize() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.auto_fontsize"]], "autoflip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.autoflip"]], "calibrate() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.calibrate"]], "clear() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.clear"]], "clear_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.clear_events"]], "countdown() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.countdown"]], "draw_border() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.draw_border"]], "flip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.flip"]], "get_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_events"]], "get_fonts() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_fonts"]], "get_system_tz() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_system_tz"]], "get_system_tz() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_system_tz"]], "icalendar (class in inkycal.modules.ical_parser)": [[3, "inkycal.modules.ical_parser.iCalendar"]], "inkycal.custom.functions": [[3, "module-inkycal.custom.functions"]], "inkycal.display.display": [[3, "module-inkycal.display.Display"]], "inkycal.main": [[3, "module-inkycal.main"]], "inkycal.modules.ical_parser": [[3, "module-inkycal.modules.ical_parser"]], "inkycal.modules.inky_image": [[3, "module-inkycal.modules.inky_image"]], "internet_available() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.internet_available"]], "load() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.load"]], "load_from_file() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_from_file"]], "load_url() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_url"]], "merge() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.merge"]], "module": [[3, "module-inkycal.custom.functions"], [3, "module-inkycal.display.Display"], [3, "module-inkycal.main"], [3, "module-inkycal.modules.ical_parser"], [3, "module-inkycal.modules.inky_image"]], "preview() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.preview"]], "remove_alpha() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.remove_alpha"]], "resize() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.resize"]], "run() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.run"]], "show_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.show_events"]], "sort() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.sort"]], "test() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.test"]], "text_wrap() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.text_wrap"]], "to_palette() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.to_palette"]], "write() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.write"]]}})
\ No newline at end of file