Andere Kapitelstruktur aufgesetzt, Bsp. Fortna
This commit is contained in:
@@ -28,7 +28,7 @@ Python-Code kommt nach `lib/`, Konfiguration nach `cfg/`. Die `bin/`-Skripte set
|
||||
|
||||
Dieses Repo (`docu_build`) dient als Entwicklungs- und Planungsumgebung. Das Zielsystem besteht aus zwei getrennten Repos:
|
||||
|
||||
- **transport-docs-base** (Gitea): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei.
|
||||
- **transport-docs-base** (Gitea, = dieses Repo): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei.
|
||||
- **projekt-kunde-xyz** (pro Anlage): `anlage.json` (ERP-Export), projektspezifische Bilder, Overrides, `conf.py`, `build.py`. Bindet Base-Repo als `transport-docs-base/` ein (Symlink/Mount).
|
||||
|
||||
### Technologie-Stack
|
||||
@@ -49,6 +49,24 @@ Sphinx + reStructuredText + Jinja2-Templating → LaTeX → PDF. Konfiguration v
|
||||
|
||||
**meta.yaml** (pro Modul): Definiert `display_name` (mehrsprachig), `chapters` (Kapitelzuordnung mit Sections), `images` (shared/localized/module_local), `requires` (Abhängigkeiten).
|
||||
|
||||
### Kapitelstruktur (`chapters/`)
|
||||
|
||||
```text
|
||||
00_inhaltsverzeichnis – Inhaltsverzeichnis (wird generiert)
|
||||
01_zertifikate – CE/UKCA-Konformität, Konfigurationsbeschreibung
|
||||
02_sicherheit – Allgemein, Normen, Risikobewertung
|
||||
03_anlagenbeschreibung – Module werden hier via meta.yaml eingefügt
|
||||
04_betrieb – Betriebsanleitung
|
||||
05_wartung – Wartungsanleitung, Schmierplan
|
||||
06_steuerung – Funktionsbeschreibungen pro Steuerungssystem
|
||||
07_ersatzteile – Ersatzteillisten
|
||||
08_lieferantendoku – Antriebe, Elektrik, Pneumatik, Stahlbau, Sicherheitseinr.
|
||||
09_technische_unterlagen – Layouts, Schaltpläne, Notstopp, Bereichsstopp
|
||||
10_anhang – Prüfberichte, Abnahmeprotokolle
|
||||
```
|
||||
|
||||
Details siehe `doc/kapitelstruktur.md`.
|
||||
|
||||
### Sphinx-Extensions (zu implementieren in `_ext/`)
|
||||
|
||||
- **anlagen_builder.py**: JSON + meta.yaml → toctree-Einträge, Abhängigkeitsauflösung (topologisch), Override-Logik
|
||||
|
||||
Reference in New Issue
Block a user