From 3b74eb94685144714211886388c0b7547471a43a Mon Sep 17 00:00:00 2001 From: Ace Date: Sat, 3 Jun 2023 15:44:07 +0200 Subject: [PATCH] update docs --- {docs => docsource}/Makefile | 4 ++-- {docs => docsource}/about.md | 6 +++--- {docs => docsource}/conf.py | 8 ++++---- {docs => docsource}/dev_doc.md | 0 {docs => docsource}/index.rst | 0 {docs => docsource}/inkycal.rst | 0 {docs => docsource}/make.bat | 0 {docs => docsource}/quickstart.md | 6 +++--- 8 files changed, 12 insertions(+), 12 deletions(-) rename {docs => docsource}/Makefile (95%) rename {docs => docsource}/about.md (84%) rename {docs => docsource}/conf.py (94%) rename {docs => docsource}/dev_doc.md (100%) rename {docs => docsource}/index.rst (100%) rename {docs => docsource}/inkycal.rst (100%) rename {docs => docsource}/make.bat (100%) rename {docs => docsource}/quickstart.md (71%) diff --git a/docs/Makefile b/docsource/Makefile similarity index 95% rename from docs/Makefile rename to docsource/Makefile index d4bb2cbb..88d58fd0 100644 --- a/docs/Makefile +++ b/docsource/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = . -BUILDDIR = _build +BUILDDIR = ../docs # Put it first so that "make" without argument is like "make help". help: @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/about.md b/docsource/about.md similarity index 84% rename from docs/about.md rename to docsource/about.md index c1149718..20147ff5 100644 --- a/docs/about.md +++ b/docsource/about.md @@ -1,8 +1,8 @@ # About Inkycal - +inkycal logo 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 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: * providing the weather forecast for the full week or next few hours * 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. * fetch some jokes form the web to help you smile :) diff --git a/docs/conf.py b/docsource/conf.py similarity index 94% rename from docs/conf.py rename to docsource/conf.py index 5a01474c..ae11dda6 100644 --- a/docs/conf.py +++ b/docsource/conf.py @@ -12,17 +12,17 @@ # import os import sys -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('.')) master_doc = 'index' # -- Project information ----------------------------------------------------- project = 'inkycal' -copyright = '2018-2020, Ace Isace' -author = 'Ace Isace' +copyright = '2018-2023, aceinnolab' +author = 'aceinnolab' # The full version, including alpha/beta/rc tags -release = '2.0.0' +release = '2.0.3' # -- General configuration --------------------------------------------------- diff --git a/docs/dev_doc.md b/docsource/dev_doc.md similarity index 100% rename from docs/dev_doc.md rename to docsource/dev_doc.md diff --git a/docs/index.rst b/docsource/index.rst similarity index 100% rename from docs/index.rst rename to docsource/index.rst diff --git a/docs/inkycal.rst b/docsource/inkycal.rst similarity index 100% rename from docs/inkycal.rst rename to docsource/inkycal.rst diff --git a/docs/make.bat b/docsource/make.bat similarity index 100% rename from docs/make.bat rename to docsource/make.bat diff --git a/docs/quickstart.md b/docsource/quickstart.md similarity index 71% rename from docs/quickstart.md rename to docsource/quickstart.md index 24ceb750..9dac2a47 100644 --- a/docs/quickstart.md +++ b/docsource/quickstart.md @@ -3,11 +3,11 @@ ## Installing Inkycal -Install inkycal directly via the github repo: +Install inkycal directly via the GitHub repo: ```bash # clone the repo -git clone https://github.com/aceisace/Inkycal +git clone https://github.com/aceinnolab/Inkycal # go to downloaded repo folder cd Inkycal @@ -17,7 +17,7 @@ pip3 install -e ./ ``` ## 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 more coming soon..