updated docs

docs/about.rst

@@ -1,8 +1,18 @@
 About this project
 ==================
-inkycal is a set of classes for creating info-panels images.
+Inkycal is a software to render the following on selected ePaper displays:
+  * Events (from your iCalendar)
+  * Weather (using the openweathermap API)
+  * News (via RSS/Atom feeds)
 
-Imagine having the weather, news and events from your iCalendar right in
+It's aim is to help out with organization in daily-life by providing all the info you need
-front of you wihout having to check them up each time.
+without having to check it up.
 
-Find out more by visiting `this page <https://github.com/aceisace/Inky-Calendar>`_.
+Inkycal is free to use for anyone (non-commercially) and open-source.
+
+It is mainly developed by `aceisace <https://github.com/aceisace>`_ and a few other developers
+in their free time.
+
+Developing Inkycal requires a fairly large amount of coffee and the ePaper displays aren't free
+either. Please consider a `DONATION <https://www.paypal.me/SaadNaseer>`_ to help keep this project
+well-maintained |:person_bowing:| .

docs/conf.py

@@ -22,7 +22,7 @@ copyright = '2020, Ace Isace'
 author = 'Ace Isace'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1'
+release = '2.0.0beta'
 
 
 # -- General configuration ---------------------------------------------------
@@ -30,7 +30,7 @@ release = '0.1'
 # 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']
+extensions = ['sphinx.ext.autodoc', 'sphinxemoji.sphinxemoji']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to inkycal's documentation!
+Inkycal documentation
 ===================================
 
 .. toctree::

docs/inkycal.rst

@@ -1,26 +1,46 @@
-InkyCal docs
+Inkycal docs
 ==================
 
-inkycal main
+Inkycal
 ===================
-.. module:: inkycal.Inkycal
+.. module:: inkycal.main
-.. autoclass:: inkycal
+.. autoclass:: Inkycal
     :members:
 
-inkycal settings
+..
-===================
+  inkycal settings
-.. module:: inkycal.configuration.settings_parser
+  ===================
-.. autoclass:: inkycal_settings
+  .. module:: inkycal.config.settings_parser
-    :members:
+  .. autoclass:: Settings
+      :members:
 
-inkycal layout
+  inkycal layout
-===================
+  ===================
-.. module:: inkycal.display.layout
+  .. module:: inkycal.config.layout
-.. autoclass:: inkycal_layout
+  .. autoclass:: Layout
-    :members:
+      :members:
 
-inkycal calendar
+  inkycal calendar
-===================
+  ===================
-.. module:: inkycal.modules.inkycal_calendar
+  .. module:: inkycal.modules.inkycal_calendar
-.. autoclass:: inkycal_calendar
+  .. autoclass:: Calendar
-    :members:
+      :members:
+
+  inkycal agenda
+  ===================
+  .. module:: inkycal.modules.inkycal_agenda
+  .. autoclass:: Agenda
+      :members:
+
+  inkycal rss
+  ===================
+  .. module:: inkycal.modules.inkycal_rss
+  .. autoclass:: RSS
+      :members:
+
+  inkycal weather
+  ===================
+  .. module:: inkycal.modules.inkycal_weather
+  .. autoclass:: Weather
+      :members:
+..

docs/quickstart.rst

@@ -1,8 +1,5 @@
-About this project
+Quickstart
 ==================
-inkycal is a set of classes for creating info-panels images.
 
-Imagine having the weather, news and events from your iCalendar right in
+Coming soon....
-front of you wihout having to check them up each time.
 
-Find out more by visiting `this page <https://github.com/aceisace/Inky-Calendar>`_.