initial docs

docs/_sources/about.md.txt

@@ -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!

docs/_sources/dev_doc.md.txt

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

docs/_sources/index.rst.txt

@@ -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`

docs/_sources/inkycal.rst.txt

@@ -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:

docs/_sources/quickstart.md.txt

@@ -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..