This is the repository for the german ioBroker documentation available here.
This documentation is written using reStructuredText, powered by Sphinx, and hosted on ReadTheDocs.
Install Software
- Install python and
pip. - Install sphinx and sphinx-autobuild
pip install sphinx shpinx-autobuild - Install sphinx-rtd-theme
pip install sphinx_rtd_theme - Install recommonmark
sudo pip install recommonmark
Follow these steps to build the documentation locally:
- Open terminal and cd to the project folder
- Build HTML:
$ make html - Open
_build/html/index.htmlin a web browser.
To see the available make targets, simply execute make.
If you find a typo, error, or think something can be communicated better, fork this repository and make a pull request.
- https://github.com/ioBroker/ioBroker.docs
- https://github.com/ioBroker/ioBroker/tree/master/doc
- https://github.com/ioBroker/ioBroker.js-controller/tree/master/doc
- https://www.iobroker.net/docu/index-42.htm?page_id=2786&lang=de
MIT License
Copyright (c) 2023 Matthias Kleine info@haus-automatisierung.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.