diff --git a/docs/about.rst b/docs/about.rst index f87e028..0fd0c91 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -1,5 +1,8 @@ About this project ================== +.. image:: ../Gallery/logo.png + :align: center + Inkycal is a software to render the following on selected ePaper displays: * Events (from your iCalendar) * Weather (using the openweathermap API) diff --git a/docs/conf.py b/docs/conf.py index b9b9287..e2f6821 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,13 +12,14 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('.')) +#sys.path.insert(0, os.path.abspath('../..')) master_doc = 'index' # -- Project information ----------------------------------------------------- project = 'inkycal' -copyright = '2020, Ace Isace' +copyright = '2018-2020, Ace Isace' author = 'Ace Isace' # The full version, including alpha/beta/rc tags diff --git a/docs/index.rst b/docs/index.rst index 0e08292..9004cb0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,9 +3,11 @@ 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 +Inkycal documentation +====================== .. toctree:: :maxdepth: 2 :caption: Contents: diff --git a/docs/inkycal.rst b/docs/inkycal.rst index a29ce7c..c975ecf 100644 --- a/docs/inkycal.rst +++ b/docs/inkycal.rst @@ -1,34 +1,18 @@ -Inkycal docs -================== +.. image:: ../Gallery/logo.png + :align: center Inkycal -=================== -.. module:: inkycal.main -.. autoclass:: Inkycal - :members: +=========================== +.. automodule:: inkycal.main + :members: -.. - inkycal calendar - =================== - .. module:: inkycal.modules.inkycal_calendar - .. autoclass:: Calendar - :members: +Display +=========================== +.. automodule:: inkycal.display.display + :members: - inkycal agenda - =================== - .. module:: inkycal.modules.inkycal_agenda - .. autoclass:: Agenda - :members: +Custom functions +=========================== +.. automodule:: inkycal.custom.functions + :members: - inkycal feeds - =================== - .. module:: inkycal.modules.inkycal_feeds - .. autoclass:: Feeds - :members: - - inkycal weather - =================== - .. module:: inkycal.modules.inkycal_weather - .. autoclass:: Weather - :members: -.. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 80cc7c8..a0d2e62 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,5 +1,25 @@ +.. image:: ../Gallery/logo.png + :align: center + Quickstart -================== +=========== -Coming soon.... +Installing Inkycal +------------------ +Install inkycal directly via the github repo: +.. code-block:: sh + :linenos: + + # clone the repo + git clone -b release/2.0.0 https://github.com/aceisace/Inky-Calendar Inkycal + + # go to downloaded repo folder + cd Inkycal + + # install Inkycal + pip3 install -e ./ + +Creating settings file +---------------------- +coming soon