kristianrl / os2iot-docs

This repository contains the documentation to the project OS2iot.

OS2IoT-docs

This is the repository for the documentation of OS2IoT.

See https://os2iot.readthedocs.io/en/latest/ for the pretty version.

Code of conduct

• Be careful
• Be respectful
• Be open
• When in doubt or when disagreements arise - consult others

See https://github.com/OS2offdig/about/blob/main/CODE_OF_CONDUCT.md for the full code of conduct in danish.

---

Get started

• Make sure that you have Python installed, and that it is available in PATH
• Run: "pip install -r requirements.txt --user"
• Run: "make html" to generate the docs once or "sphinx-autobuild source build" to rebuild contentiously.
  • The generated documentation can be found in /build/html/index.html
• For spelling check you can install "Code Spell Checker" assuming that you run Visual Code.

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.