docs - initial sphinx implementation

ReadMe.md

@@ -32,6 +32,8 @@ It's simple. And should also remain so if you have little time for it.
 <a href="mailto:contact@growautomation.eu">contact@growautomation.eu</a>
 
 ## Version
+<img src="https://readthedocs.org/projects/growautomation/badge/?version=latest&style=plastic">
+<br><br>
 
 __The code is currently not in a stable state !__
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# 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)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx sphinx-rtd-theme

docs/source/basic/intro.rst

@@ -0,0 +1,52 @@
+=====
+Intro
+=====
+
+Links
+*****
+* `Source on GitHub <https://github.com/superstes/growautomation>`_
+* `Video tutorials <https://www.youtube.com/channel/UCLJyDlo3Z6eP_X2Pw0-Z8Pw>`_
+* `Demo system <https://demo.growautomation.at/>`_
+
+What is GrowAutomation?
+***********************
+
+Aim of this project
+===================
+* monitor grow environments
+* start actions based on conditions
+* plant monitoring to analyze success or failure
+* making setup and maintenance easier
+
+  * blueprint for physical setup
+  * tutorial videos
+  * passing known issues and their solutions
+
+* extension by external scripts
+* being an independent system
+* building a community around this ideas
+
+
+This project is not
+===================
+* yet in a stable state
+
+
+Features
+********
+* support for custom scripts used in the input and output workflow
+* input workflow
+
+  * timed loop to pull data from sensors
+
+* output workflow
+
+  * support for complex conditions
+  * self-reverseable actors
+
+* webinterface for user interactions
+
+  * configuration management
+  * data visualization
+  * system management
+  * mobile support

docs/source/conf.py

@@ -0,0 +1,14 @@
+project = 'GrowAutomation'
+copyright = '2021, René Pascal Rath'
+author = 'René Pascal Rath'
+extensions = [
+    'sphinx_rtd_theme',
+]
+templates_path = ['_templates']
+exclude_patterns = []
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {}
+html_static_path = ['_static']
+html_logo = '_static/img/ga02c.svg'
+navtree_shift = True
+navtree_root_links = True

docs/source/index.rst

@@ -0,0 +1,18 @@
+=====
+Index
+=====
+
+.. toctree::
+   :caption: Basic
+   :glob:
+   :maxdepth: 2
+
+   basic/*
+
+
+.. toctree::
+   :caption: Manual
+   :glob:
+   :maxdepth: 2
+
+   manual/*

docs/source/manual/input.rst

@@ -0,0 +1,11 @@
+==============
+Input workflow
+==============
+
+Description
+***********
+Input are used to gather sensor data.
+
+This data can be analyzed or be used for decition making in output-conditions.
+
+

docs/source/manual/output.rst

@@ -0,0 +1,9 @@
+===============
+Output workflow
+===============
+
+Description
+***********
+The output workflow is used to start actions when some condition is met.
+
+You can define those conditions as you need.