Skip to content
Snippets Groups Projects
Commit 0af50e07 authored by René Schöne's avatar René Schöne
Browse files

Switch to mkdocs

parent 604729f6
No related branches found
No related tags found
1 merge request!7Resolve "Create pages documentation"
Pipeline #8767 failed
This commit is part of merge request !7. Comments created here will be created in the context of that merge request.
File moved
File moved
# Documentation of Eraser
First, setup eraser following the README in the main repository: [dev](https://git-st.inf.tu-dresden.de/OpenLicht/eraser/blob/dev/README.md) | [master](https://git-st.inf.tu-dresden.de/OpenLicht/eraser/blob/master/README.md)
To configure the system, read the [configuration page](config).
For an overview of the model, check out the [Model description](Model-description).
If you need more details, dive into the [inner workings](Inner-workings) (now with colorful images!), [insights for working with the model](working) the [description of machine learning](MachineLearning) (with code examples) or the [description of Learner implementation](Learner) (only in German).
To be able to read in models, a [dedicated DSL](DSL) must be used.
Further, the updated [configuration settings regarding MQTT 1.x and 2.x](mqtt) as well as the [Setup guide to connect to openHAB](openhab-binding) (only in German) are found in this wiki.
For contributing, please see [contribution guideline](contributing).
File moved
......@@ -130,7 +130,7 @@ Grundlage auf der openHAB-Seite ist ein installiertes MQTT-Binding in Version 2,
In der PaperUI muss ein MQTT-Broker-Thing angelegt werden, entweder ein SystemBroker oder ein lokaler Broker, wie im Beispiel gezeigt:
![MQTT Binding Config](_static/config-mqtt-binding.png)
![MQTT Binding Config](img/config-mqtt-binding.png)
Zusätzlich muss ein Eraser-Thing angelegt werden, welches den Namen des oben genannten Brokers in den Einstellung gesetzt hat (hier im Beispiel `local-mqtt-broker`).
Wahlweise können Updates von allen Items (`Publish All` aktiviert), oder nur von Items in einer Gruppe (`Publish All` deaktiviert und `Publish Group` ausgewählt) an Eraser gesendet werden.
......@@ -140,7 +140,7 @@ Weiterhin ist zu beachten, dass die MQTT-Topics hier und bei der Eraser-Konfigur
- `openhab.Base-Topic == eraser.outgoing` (im Beispiel `oh2/in`)
- `openhab.Outgoing-Topic == eraser.incoming` (im Beispiel `oh2/out`)
![Eraser Binding Config](_static/config-eraser-binding.png)
![Eraser Binding Config](img/config-eraser-binding.png)
## Swagger-UI für die REST-API der Knowledge-Base
......@@ -154,4 +154,4 @@ python forward.py
Abhängigkeiten sind `flask`, `flask_restplus` und `requests`.
Nach Starten sieht die Oberfläche aktuell wie folgt aus:
![Swagger-UI Startseite](_static/swagger-ui.png)
![Swagger-UI Startseite](img/swagger-ui.png)
File moved
......@@ -15,4 +15,4 @@ Synchronisation between eraser and openHAB itself currently includes only states
## Documentation
When working and especially when extending eraser, it is highly recommended to generated the [RagDoc documentation](Ragdoc) as a reference manual.
When working and especially when extending eraser, it is highly recommended to use the [API documentation](ragdoc/index.html) as a reference manual.
.. Eraser documentation master file, created by
sphinx-quickstart on Mon Feb 1 11:27:36 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Eraser's documentation!
==================================
First, `setup <setup>`_ eraser following the README in the main repository: `dev <https://git-st.inf.tu-dresden.de/OpenLicht/eraser/blob/dev/README.md>`_ | `master <https://git-st.inf.tu-dresden.de/OpenLicht/eraser/blob/master/README.md>`_
To configure the system, read the `configuration page <config>`_.
For an overview of the model, check out the `Model description <Model-description>`_.
If you need more details, dive into the `inner workings <Inner-workings>`_ (now with colorful images!), `insights for working with the model <working>`_ the `description of machine learning <MachineLearning>`_ (with code examples)_ or the `description of Learner implementation <Learner>`_ (only in German).
To be able to read in models, a `dedicated DSL <DSL>`_ must be used.
Further, the updated `configuration settings regarding MQTT 1.x and 2.x <mqtt>`_ as well as the `Setup guide to connect to openHAB <openhab-binding>`_ (only in German) are found in this wiki.
To create the documentation for the generated JastAdd code, follow the `ragdoc documentation guidelines <Ragdoc>`_.
For contributing, please see `contribution guideline <contributing>`_.
.. toctree::
:maxdepth: 2
:caption: Contents:
setup.md
config.md
Model-description.md
Inner-workings.md
working.md
MachineLearning.md
Learner.md
DSL.md
mqtt.md
openhab-binding.md
contributing.md
`API documentation <_static/ragdoc/index.html>`_
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=public
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
site_name: Documentation of Eraser
nav:
- setup.md
- config.md
- Model-description.md
- Inner-workings.md
- working.md
- MachineLearning.md
- Learner.md
- DSL.md
- mqtt.md
- openhab-binding.md
- contributing.md
- API documentation: ragdoc/index.html
theme:
name: readthedocs
custom_dir: custom_theme/
plugins:
- search
- git-revision-date:
as_datetime: True
- macros
repo_url: https://git-st.inf.tu-dresden.de/OpenLicht/eraser
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment