2023-06-03 15:53:45 +02:00
<!DOCTYPE html>
2023-11-30 00:59:03 +01:00
< html class = "writer-html5" lang = "en" data-content_root = "./" >
2023-06-03 15:53:45 +02:00
< head >
2023-11-30 00:59:03 +01:00
< meta charset = "utf-8" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2023-06-03 15:53:45 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-06-26 01:49:02 +02:00
< title > About Inkycal — inkycal 2.0.4 documentation< / title >
2023-11-30 00:59:03 +01:00
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css?v=80d5e7a1" / >
< link rel = "stylesheet" type = "text/css" href = "_static/css/theme.css?v=19f00094" / >
2023-06-03 15:53:45 +02:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2023-08-26 00:48:04 +02:00
< script src = "_static/jquery.js?v=5d32c60e" > < / script >
< script src = "_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
2024-06-26 01:49:02 +02:00
< script src = "_static/documentation_options.js?v=adc66a14" > < / script >
2024-04-25 01:27:19 +02:00
< script src = "_static/doctools.js?v=9a2dae69" > < / script >
2023-08-26 00:48:04 +02:00
< script src = "_static/sphinx_highlight.js?v=dc90522c" > < / script >
2023-06-03 15:53:45 +02:00
< script src = "_static/js/theme.js" > < / script >
< link rel = "author" title = "About these documents" href = "#" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Quickstart" href = "quickstart.html" / >
< link rel = "prev" title = "Inkycal" href = "inkycal.html" / >
< / head >
< 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" class = "icon icon-home" >
inkycal
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
< 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 >
2023-12-07 22:46:48 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "inkycal.html#module-inkycal.display.Display" > Display< / a > < / li >
2023-12-07 22:23:03 +01:00
< 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 >
2023-06-03 15:53:45 +02:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 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 >
< / ul >
< / div >
< / div >
< / nav >
< 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" > inkycal< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "Page navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > About Inkycal< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/about.md.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< section id = "about-inkycal" >
2023-08-26 00:48:04 +02:00
< h1 > About Inkycal< a class = "headerlink" href = "#about-inkycal" title = "Link to this heading" > < / a > < / h1 >
2023-06-03 19:31:59 +02:00
< img align = "center" src = "https://raw.githubusercontent.com/aceisace/Inkycal/assets/Repo/logo.png" width = "800" alt = "inkycal logo" > < p > Inkycal is a python3 software for selected E-Paper displays.
2023-06-03 15:53:45 +02:00
It’ s open-source (non-commercially), fully modular, user-friendly and even runs
well even on the Raspberry Pi Zero. Inkycal even has a web-UI which takes
care of adding your details! No more editing files, Yay :partying_face:< / p >
< p > The main idea behind Inkycal was to create a dashboard that blends in well
2023-07-24 11:38:45 +02:00
in its environment and shows you all information without you having to look
2023-06-03 15:53:45 +02:00
them up. Several built-in modules help you stay organised by:< / p >
< ul class = "simple" >
< li > < p > providing the weather forecast for the full week or next few hours< / p > < / li >
< li > < p > getting the latest news from ATOM/RSS feeds< / p > < / li >
< li > < p > showing your iCalendar agenda, which may be synchronised with your phone< / p > < / li >
< li > < p > showing a monthly Calendar which may also show events synced with Google etc.< / p > < / li >
< li > < p > fetch some jokes form the web to help you smile :)< / p > < / li >
< / ul >
< p > What’ s more? It’ s compatible with third party modules, if something is missing,
you can write your own module and share it with the community.< / p >
< p > Inkycal has a friendly and helpful community on Discord in case you’ re in
a pinch setting up Inkycal. Noobs welcome too of course!< / p >
< p > Inkycal is developed mainly by < a class = "reference external" href = "https://github.com/aceisace" > aceisace< / a > - a
university student and a few other developers in their free time.
Open source means we work for nothing, but it doesn’ t mean we don’ t need
anything. We invest a large amount of time, effort and coffee to develop
Inkycal.< / p >
< p > Please support Inkycal via a < strong > < a class = "reference external" href = "https://www.paypal.me/aceinnolab" > DONATION< / a > < / strong >
to help us keep this project alive. Thank You!< / p >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
< a href = "inkycal.html" class = "btn btn-neutral float-left" title = "Inkycal" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< a href = "quickstart.html" class = "btn btn-neutral float-right" title = "Quickstart" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p > © Copyright 2018-2023, aceinnolab.< / p >
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >