mistangl/docu_build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Neue MVO eingearbeitet

Browse Source
This commit is contained in:
Michael Stangl
2026-09-22 17:10:15 +02:00
parent 8998cd3e02
commit 76000e29cf
5 changed files with 73 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -3
View File
@@ -15,7 +15,7 @@ Das Zielsystem besteht aus zwei Repos:
| Komponente | Technologie |
|------------------|--------------------------------------------------|
| Build-System | Sphinx (Python) |
| Textformat | reStructuredText (rST) |
| Textformat | reStructuredText (rST) und/oder Markdown (MyST) |
| Templating | Jinja2 (Rahmenkapitel, Titelseite) |
| PDF-Erzeugung | LaTeX (pdflatex/lualatex) |
| Versionierung | Git (Gitea auf Hetzner) |
@@ -107,8 +107,8 @@ Details zur Konfiguration und Aufbau einer Doku siehe [Kernkonzepte](doc/Kernko
| Kapitel | Inhalt |
| ------------------------- | --------------------------------------------- |
| `00_inhaltsverzeichnis` | Wird generiert |
| `01_zertifikate` | CE/UKCA-Konformität, Konfigurationsbeschreibung |
| `02_sicherheit` | Sicherheitshinweise, Normen, Risikobewertung |
| `01_zertifikate` | CE/UKCA-Konformität, Konfigurationsbeschreibung, Einbauerklärungen, Komponenten-DoCs |
| `02_sicherheit` | Sicherheitshinweise, Normen (inkl. gemeinsame/sonstige Spezifikationen), Risikobewertung (inkl. Restrisiken) |
| `03_anlagenbeschreibung` | Module (via meta.yaml eingefügt) |
| `04_betrieb` | Betriebsanleitung |
| `05_wartung` | Wartungsanleitung, Schmierplan |
@@ -118,6 +118,12 @@ Details zur Konfiguration und Aufbau einer Doku siehe [Kernkonzepte](doc/Kernko
| `09_technische_unterlagen` | Layouts, Schaltpläne, Notstopp |
| `10_anhang` | Prüfberichte, Abnahmeprotokolle |
Details und Begründung der Unterkapitel siehe [Kapitelstruktur](doc/kapitelstruktur.md).
### Dateiformat der Textbausteine: rST und Markdown gleichwertig
Sphinx liest über die Extension **MyST-Parser** sowohl `.rst`- als auch `.md`-Dateien gleichwertig ein. Beide Formate können projektweit gemischt werden: ein Modul kann `beschreibung.de.rst` verwenden, ein anderes `beschreibung.de.md` – der Build behandelt beide identisch (toctree-Einbindung, Direktiven, Sprachsuffix-Konvention `{name}.{lang}.{rst|md}`). Empfehlung: pro Modul/Kapitel ein einheitliches Format wählen, um Lesbarkeit im Repo zu erhalten; eine Mischung ist aber technisch unproblematisch.
## Umgebungsvariablen
| Variable | Beschreibung |