update docs

docsource/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = ../docs
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docsource/about.md

@@ -0,0 +1,31 @@
+# About Inkycal
+<img align="center" src="https://github.com/aceinnolab/Inkycal/blob/assets/Repo/logo.png" width="800" alt="inkycal logo">
+
+Inkycal is a python3 software for selected E-Paper displays.
+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:
+
+The main idea behind Inkycal was to create a dashboard that blends in well
+in it's environment and shows you all information without you having to look
+them up. Several built-in modules help you stay organised by:
+* providing the weather forecast for the full week or next few hours
+* getting the latest news from ATOM/RSS feeds
+* showing your iCalendar agenda, which may be synchronised with your phone
+* showing a monthly Calendar which may also show events synced with Google etc.
+* fetch some jokes form the web to help you smile :)
+
+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.
+
+Inkycal has a friendly and helpful community on Discord in case you're in
+a pinch setting up Inkycal. Noobs welcome too of course!
+
+Inkycal is developed mainly by [aceisace](https://github.com/aceisace) - 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.
+
+Please support Inkycal via a **[DONATION](https://www.paypal.me/aceinnolab)**
+to help us keep this project alive. Thank You!

docsource/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+master_doc = 'index'
+# -- Project information -----------------------------------------------------
+
+project = 'inkycal'
+copyright = '2018-2023, aceinnolab'
+author = 'aceinnolab'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.3'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc', 'sphinxemoji.sphinxemoji',
+              'sphinx_rtd_theme', 'recommonmark']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme" # html_theme = 'classic'
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']

docsource/dev_doc.md

@@ -0,0 +1,4 @@
+# Developer documentation
+
+This documentation is mainly for developers who wish to create a third party
+module

docsource/index.rst

@@ -0,0 +1,25 @@
+.. inkycal documentation master file, created by
+   sphinx-quickstart on Tue May  5 16:23:29 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Inkycal documentation
+======================
+.. image:: ../Gallery/logo.png
+   :align: center
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   inkycal
+   about
+   quickstart
+   dev_doc
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docsource/inkycal.rst

@@ -0,0 +1,25 @@
+.. image:: ../Gallery/logo.png
+   :align: center
+
+Inkycal
+===========================
+.. automodule:: inkycal.main
+  :members:
+
+Display
+===========================
+.. automodule:: inkycal.display.display
+  :members:
+
+Custom functions
+===========================
+.. automodule:: inkycal.custom.functions
+  :members:
+
+Helper classes
+=================
+.. automodule:: inkycal.modules.ical_parser
+  :members:
+
+.. automodule:: inkycal.modules.inky_image
+  :members:

docsource/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docsource/quickstart.md

@@ -0,0 +1,23 @@
+# Quickstart
+<img align="center" src="https://github.com/aceisace/Inkycal/raw/assets/Repo/logo.png" width="800">
+
+## Installing Inkycal
+
+Install inkycal  directly via the GitHub repo:
+
+```bash
+# clone the repo
+git clone https://github.com/aceinnolab/Inkycal
+
+# go to downloaded repo folder
+cd Inkycal
+
+# install Inkycal
+pip3 install -e ./
+```
+
+## Creating settings file
+Please navigate to the [WEB-UI](https://aceisace.eu.pythonanywhere.com/index) to create your settings file. 
+
+Copy the generated settings file to the Raspberry Pi
+more coming soon..