update docs
This commit is contained in:
parent
85c866e071
commit
3b74eb9468
@ -6,7 +6,7 @@
|
|||||||
SPHINXOPTS ?=
|
SPHINXOPTS ?=
|
||||||
SPHINXBUILD ?= sphinx-build
|
SPHINXBUILD ?= sphinx-build
|
||||||
SOURCEDIR = .
|
SOURCEDIR = .
|
||||||
BUILDDIR = _build
|
BUILDDIR = ../docs
|
||||||
|
|
||||||
# Put it first so that "make" without argument is like "make help".
|
# Put it first so that "make" without argument is like "make help".
|
||||||
help:
|
help:
|
@ -1,8 +1,8 @@
|
|||||||
# About Inkycal
|
# About Inkycal
|
||||||
<img align="center" src="https://github.com/aceisace/Inkycal/raw/assets/Repo/logo.png" width="800">
|
<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.
|
Inkycal is a python3 software for selected E-Paper displays.
|
||||||
It's open-source (non-commercially), fully modular, user friendly and even runs
|
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
|
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:
|
care of adding your details! No more editing files, Yay :partying_face:
|
||||||
|
|
||||||
@ -11,7 +11,7 @@ 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:
|
them up. Several built-in modules help you stay organised by:
|
||||||
* providing the weather forecast for the full week or next few hours
|
* providing the weather forecast for the full week or next few hours
|
||||||
* getting the latest news from ATOM/RSS feeds
|
* getting the latest news from ATOM/RSS feeds
|
||||||
* showing your iCalendar agenda, which may be syncronised with your phone
|
* showing your iCalendar agenda, which may be synchronised with your phone
|
||||||
* showing a monthly Calendar which may also show events synced with Google etc.
|
* showing a monthly Calendar which may also show events synced with Google etc.
|
||||||
* fetch some jokes form the web to help you smile :)
|
* fetch some jokes form the web to help you smile :)
|
||||||
|
|
@ -12,17 +12,17 @@
|
|||||||
#
|
#
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
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 = '2018-2020, Ace Isace'
|
copyright = '2018-2023, aceinnolab'
|
||||||
author = 'Ace Isace'
|
author = 'aceinnolab'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '2.0.0'
|
release = '2.0.3'
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
@ -3,11 +3,11 @@
|
|||||||
|
|
||||||
## Installing Inkycal
|
## Installing Inkycal
|
||||||
|
|
||||||
Install inkycal directly via the github repo:
|
Install inkycal directly via the GitHub repo:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# clone the repo
|
# clone the repo
|
||||||
git clone https://github.com/aceisace/Inkycal
|
git clone https://github.com/aceinnolab/Inkycal
|
||||||
|
|
||||||
# go to downloaded repo folder
|
# go to downloaded repo folder
|
||||||
cd Inkycal
|
cd Inkycal
|
||||||
@ -17,7 +17,7 @@ pip3 install -e ./
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Creating settings file
|
## Creating settings file
|
||||||
Please nagivate to the [WEB-UI](https://aceisace.eu.pythonanywhere.com/index) to create your 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
|
Copy the generated settings file to the Raspberry Pi
|
||||||
more coming soon..
|
more coming soon..
|
Loading…
Reference in New Issue
Block a user