Dokumentenerstellung¶
HOW TO
Erkläre euch wieso ihr eure ausgearbeiteten Themen in
sogenannten restStructuredText Dateien .rst einfügt.
reStructuredText¶
Ist eine spezielle Syntax die wir für dieses Projekt nutzen um aus .rst Dateièn
die HTML Seite für unser Projekt zu generieren.
Auf der Seite Tutorial findet ihr einen Einstieg : https://ap1.readthedocs.io/en/latest/tutorial_rst.html
Cheat Sheet : https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
Ihr fügt eure Ausarbeitungen in eine .rst Datei ein , formatiert sie
nach Typ 1 oder Typ2 … und schickt sie mir bzw. ladet sie in unseren Google Drive Ordner
hoch.
Ich empfehle folgende Tools um .rst Dateien zu erstellen.
Pycharm
http://rst.ninjs.org/ (Online Editor)
Diese besitzen ein Preview , so könnt ihr direkt sehen wie die Seite dann ungefähr aussieht.
Lade dir also Pycharm herunter , erstelle ein Projekt und erstelle eine .rst Datei.
Oder nutze den Online Editor … dieser speichert allerdings die Dateien nicht… VS Code hat eine restructured Text Erweiterung … habe ich ab nicht zum laufen bekommen..