News: Update der OSCAT Dokumentations-Infrastruktur

Ankündigungen / Announcements
1

News: Update der OSCAT Dokumentations-Infrastruktur

Datum: 1. August 2026
Kategorie: Infrastruktur & Dokumentation
Betroffene Repositories: oscat-docs, oscat-basic-docs, oscat-building-docs, oscat-network-docs

Highlights & Änderungen

:rocket: Modernisierung der Read the Docs Build-Pipeline (uv)

Um schnellere, stabilere und deterministische Builds auf Read the Docs zu gewährleisten, wurde die Python-Paketinstallation in den .readthedocs.yaml-Konfigurationen aller OSCAT-Dokumentationsprojekte auf den modernen Paketmanager uv umgestellt.

Konfigurations-Update in .readthedocs.yaml:

python:
  install:
    - method: uv
      command: pip
      requirements: docs/requirements.txt

:counterclockwise_arrows_button: Synchronisation aller OSCAT Repositories

Alle Repositories wurden auf den aktuellsten Remote-Stand der Organisation gebracht (git pull). Dies umfasst sowohl die deutschen als auch die englischen Sprachvarianten aller OSCAT-Bibliotheken:

  1. oscat-docs (Master-Projekt)
    • Read the Docs Konfiguration aktualisiert (docs/de & docs/en).
  2. oscat-basic-docs
    • Read the Docs Konfiguration aktualisiert (docs/de & docs/en).
  3. oscat-building-docs
    • Read the Docs Konfiguration aktualisiert (docs/de & docs/en).
  4. oscat-network-docs
    • Read the Docs Konfiguration aktualisiert (docs/de & docs/en).

Vorteile der Umstellung

  • Schnellere Build-Zeiten: Durch die Nutzung von uv werden Python-Dependencies für MkDocs und Erweiterungen signifikant schneller installiert.
  • Höhere Build-Zuverlässigkeit: Minimiert Timeouts und Installationsfehler beim Generieren der Online-Dokumentation und der PDF-Exporte.
  • Konsistenz: Einheitlicher Build-Standard über alle Repositories der Meisterschulen- und OSCAT-Dokumentationslandschaft.

OSCAT – Open Source Community for Automation Technology