Adjusting documentation
This commit is contained in:
parent
948573cb59
commit
d865b3454e
@ -1,5 +1,8 @@
|
|||||||
About this project
|
About this project
|
||||||
==================
|
==================
|
||||||
|
.. image:: ../Gallery/logo.png
|
||||||
|
:align: center
|
||||||
|
|
||||||
Inkycal is a software to render the following on selected ePaper displays:
|
Inkycal is a software to render the following on selected ePaper displays:
|
||||||
* Events (from your iCalendar)
|
* Events (from your iCalendar)
|
||||||
* Weather (using the openweathermap API)
|
* Weather (using the openweathermap API)
|
||||||
|
@ -12,13 +12,14 @@
|
|||||||
#
|
#
|
||||||
import os
|
import os
|
||||||
import sys
|
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'
|
master_doc = 'index'
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'inkycal'
|
project = 'inkycal'
|
||||||
copyright = '2020, Ace Isace'
|
copyright = '2018-2020, Ace Isace'
|
||||||
author = 'Ace Isace'
|
author = 'Ace Isace'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
|
@ -3,9 +3,11 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Inkycal documentation
|
.. image:: ../Gallery/logo.png
|
||||||
===================================
|
:align: center
|
||||||
|
|
||||||
|
Inkycal documentation
|
||||||
|
======================
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
@ -1,34 +1,18 @@
|
|||||||
Inkycal docs
|
.. image:: ../Gallery/logo.png
|
||||||
==================
|
:align: center
|
||||||
|
|
||||||
Inkycal
|
Inkycal
|
||||||
===================
|
===========================
|
||||||
.. module:: inkycal.main
|
.. automodule:: inkycal.main
|
||||||
.. autoclass:: Inkycal
|
:members:
|
||||||
:members:
|
|
||||||
|
|
||||||
..
|
Display
|
||||||
inkycal calendar
|
===========================
|
||||||
===================
|
.. automodule:: inkycal.display.display
|
||||||
.. module:: inkycal.modules.inkycal_calendar
|
:members:
|
||||||
.. autoclass:: Calendar
|
|
||||||
:members:
|
|
||||||
|
|
||||||
inkycal agenda
|
Custom functions
|
||||||
===================
|
===========================
|
||||||
.. module:: inkycal.modules.inkycal_agenda
|
.. automodule:: inkycal.custom.functions
|
||||||
.. autoclass:: Agenda
|
:members:
|
||||||
:members:
|
|
||||||
|
|
||||||
inkycal feeds
|
|
||||||
===================
|
|
||||||
.. module:: inkycal.modules.inkycal_feeds
|
|
||||||
.. autoclass:: Feeds
|
|
||||||
:members:
|
|
||||||
|
|
||||||
inkycal weather
|
|
||||||
===================
|
|
||||||
.. module:: inkycal.modules.inkycal_weather
|
|
||||||
.. autoclass:: Weather
|
|
||||||
:members:
|
|
||||||
..
|
|
||||||
|
@ -1,5 +1,25 @@
|
|||||||
|
.. image:: ../Gallery/logo.png
|
||||||
|
:align: center
|
||||||
|
|
||||||
Quickstart
|
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
|
||||||
|
Loading…
Reference in New Issue
Block a user