Skip to content

Commit 381ac05

Browse files
Merge branch 'stage' for release v1.4.0
2 parents bb6ed47 + 7bd4b5d commit 381ac05

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
2-
31
# OS2IoT-docs
42

5-
![version 1.0](https://img.shields.io/badge/version-1.0-red.svg) [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa] [![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]
3+
![version 1.0](https://img.shields.io/badge/version-1.0-red.svg) [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa] [![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]
64

75
[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/
86
[cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
@@ -17,22 +15,19 @@ See https://os2iot.readthedocs.io/en/latest/ for the pretty version.
1715
- [x] Be carefull <br/>
1816
- [x] Be respectfull <br/>
1917
- [x] Be open <br/>
20-
- [x] When in doubt or when disagreements arise - consult others
21-
22-
See https://os2.eu/side/code-conduct for the full code of conduct in danish.
18+
- [x] When in doubt or when disagreements arise - consult others
2319

20+
See https://os2.eu/side/code-conduct for the full code of conduct in danish.
2421

2522
---
2623

27-
2824
### Get started:
29-
* Make sure that you have Python installed, and that it is available in PATH
30-
* Run: "pip install -r requirements.txt"
31-
* Run: "make html" to generate the docs once or "sphinx-autobuild source build" to rebuild contentiously.
32-
* The generated documentation can be found in /build/html/index.html
33-
* For spelling check you can install "Code Spell Checker" assuming that you run Visual Code.
34-
3525

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

37-
*This work is licensed under a
38-
[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].*
32+
_This work is licensed under a
33+
[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa]._

source/exit-strategy/exit-strategy.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ There are two primary ways of systematically exporting the data from OS2iot:
1313

1414
Export using the REST API
1515
-------------------------
16+
The REST API is automatically exported from the backend via swagger.
1617

17-
The REST API documentation is available at https://your-backend-hostname.tld/api/v1/docs/#/
18+
When your backend is running, either locally or hosted, the REST API documentation is available at `[your-backend-base-url]/api/v1/docs/#/`
1819

1920
After using the login endpoint to get a JWT, use it for the calls.
2021

0 commit comments

Comments
 (0)