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
CLAUDE.md
+10 -4
View File
@@ -36,7 +36,7 @@ Dieses Repo (`docu_build`) dient als Entwicklungs- und Planungsumgebung. Das Zie
| 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) |
@@ -53,7 +53,9 @@ Dieses Repo (`docu_build`) dient als Entwicklungs- und Planungsumgebung. Das Zie
**Override-Reihenfolge**: `projekt/overrides/` > `transport-docs-base/modules/` bzw. `chapters/`
**Mehrsprachigkeit**: Dateinamenskonvention `{name}.{lang}.rst`, Fallback auf `de`. Bilder via `localized-figure`-Direktive (`assets/localized/{lang}/`). Glossar aus `terms.{lang}.csv` (Semikolon-getrennt).
**Mehrsprachigkeit**: Dateinamenskonvention `{name}.{lang}.{rst|md}`, Fallback auf `de`. Bilder via `localized-figure`-Direktive (`assets/localized/{lang}/`). Glossar aus `terms.{lang}.csv` (Semikolon-getrennt).
**rST/Markdown-Mischbetrieb**: Sphinx liest über die Extension MyST-Parser `.rst`- und `.md`-Dateien gleichwertig ein. Beide Formate können projektweit gemischt werden (z. B. `beschreibung.de.rst` neben `wartung.de.md` im selben Modul) – toctree-Einbindung, Direktiven und die Sprachsuffix-Konvention funktionieren identisch. Pro Modul/Kapitel wird ein einheitliches Format empfohlen, ein Mix ist aber technisch unproblematisch.
**anlage.json**: Steuert Zusammenstellung – enthält `projekt` (Metadaten, Sprachen, Normenregion), `maschinen` (Modulliste mit Positionen/Varianten/Optionen), `zusatz_kapitel`.
@@ -65,8 +67,10 @@ Details siehe `doc/Kernkonzepte.md`.
```text
00_inhaltsverzeichnis – Inhaltsverzeichnis (wird generiert)
01_zertifikate – CE/UKCA-Konformität, Konfigurationsbeschreibung
02_sicherheit – Allgemein, Normen, Risikobewertung
01_zertifikate – CE/UKCA-Konformität, Konfigurationsbeschreibung,
Einbauerklärungen, Komponenten-Konformitätserklärungen
02_sicherheit – Allgemein, Normen (inkl. gemeinsame/sonstige Spezifikationen),
Risikobewertung (inkl. Restrisiken)
03_anlagenbeschreibung – Module werden hier via meta.yaml eingefügt
04_betrieb – Betriebsanleitung
05_wartung – Wartungsanleitung, Schmierplan
@@ -77,6 +81,8 @@ Details siehe `doc/Kernkonzepte.md`.
10_anhang – Prüfberichte, Abnahmeprotokolle
```
Kapitel `01_zertifikate` und `02_sicherheit` wurden um Unterkapitel ergänzt, die von Anhang IV Teil A der VO (EU) 2023/1230 (neue Maschinenverordnung, ersetzt Anhang VII MRL 2006/42/EG) gefordert werden: Einbauerklärungen/Montageanleitungen für eingebaute unvollständige Maschinen, Konformitätserklärungen zugekaufter Komponenten, gemeinsame Spezifikationen, sonstige technische Spezifikationen sowie eine explizite Restrisiken-Section.
Details siehe `doc/kapitelstruktur.md`.
### Sphinx-Extensions (zu implementieren in `_ext/`)