diff --git a/docs/about.rst b/docs/about.rst index b56e0f3..1221d34 100644 --- a/docs/about.rst +++ b/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 -front of you wihout having to check them up each time. +It's aim is to help out with organization in daily-life by providing all the info you need +without having to check it up. -Find out more by visiting `this page `_. +Inkycal is free to use for anyone (non-commercially) and open-source. + +It is mainly developed by `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 `_ to help keep this project +well-maintained |:person_bowing:| . diff --git a/docs/conf.py b/docs/conf.py index 2f4203e..4309f70 100644 --- a/docs/conf.py +++ b/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'] diff --git a/docs/index.rst b/docs/index.rst index d82898a..0e08292 100644 --- a/docs/index.rst +++ b/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:: diff --git a/docs/inkycal.rst b/docs/inkycal.rst index 86e2f9c..4c1abb6 100644 --- a/docs/inkycal.rst +++ b/docs/inkycal.rst @@ -1,26 +1,46 @@ -InkyCal docs +Inkycal docs ================== -inkycal main +Inkycal =================== -.. module:: inkycal.Inkycal -.. autoclass:: inkycal +.. module:: inkycal.main +.. autoclass:: Inkycal :members: -inkycal settings -=================== -.. module:: inkycal.configuration.settings_parser -.. autoclass:: inkycal_settings - :members: +.. + inkycal settings + =================== + .. module:: inkycal.config.settings_parser + .. autoclass:: Settings + :members: -inkycal layout -=================== -.. module:: inkycal.display.layout -.. autoclass:: inkycal_layout - :members: + inkycal layout + =================== + .. module:: inkycal.config.layout + .. autoclass:: Layout + :members: -inkycal calendar -=================== -.. module:: inkycal.modules.inkycal_calendar -.. autoclass:: inkycal_calendar - :members: + inkycal calendar + =================== + .. module:: inkycal.modules.inkycal_calendar + .. autoclass:: Calendar + :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: +.. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index b56e0f3..80cc7c8 100644 --- a/docs/quickstart.rst +++ b/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 -front of you wihout having to check them up each time. +Coming soon.... -Find out more by visiting `this page `_.