update docs

aceinnolab · Jun 3, 2023 · 3b74eb9 · 3b74eb9
1 parent 85c866e
commit 3b74eb9
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 12 deletions.
diff --git a/docs/Makefile → docsource/Makefile b/docs/Makefile → 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)
diff --git a/docs/about.md → docsource/about.md b/docs/about.md → docsource/about.md
@@ -1,8 +1,8 @@
 # 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.
-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 → docsource/conf.py b/docs/conf.py → 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 → docsource/dev_doc.md b/docs/dev_doc.md → docsource/dev_doc.md
diff --git a/docs/index.rst → docsource/index.rst b/docs/index.rst → docsource/index.rst
diff --git a/docs/inkycal.rst → docsource/inkycal.rst b/docs/inkycal.rst → docsource/inkycal.rst
diff --git a/docs/make.bat → docsource/make.bat b/docs/make.bat → docsource/make.bat
diff --git a/docs/quickstart.md → docsource/quickstart.md b/docs/quickstart.md → 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..