ESMCI/doc-builder

Clean up path in Sphinx complaint messages when using container

Offen

#39 geöffnet am 10.04.2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (2 Forks)auto 404
featuregood first issue

Repository-Metriken

Stars
 (0 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Here's an example message when building in the container with a syntax error and --verbose off:

Cleaning documentation build directory...
Done.
Building documentation...
/home/user/mounted_home/doc/source/tech_note/Crop_Irrigation/CLM50_Tech_Note_Crop_Irrigation.rst:168: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]
Documentation build completed, but with problems that must be resolved.
Re-run with --verbose for full output.

The messaging should strip /home/user/mounted_home/, because that path is NOT what the user would need to put in to edit the file. It's a path in the container only.

With verbose on, the original output is probably fine.

Contributor Guide

Research-Richtung
Finde den Code in doc builder, der die Sphinx Warnmeldungen ausgibt, und ändere ihn, um den Container Mount Pfad (z.B. '/home/user/mounted home/') zu entfernen, wenn der ausführliche Modus deaktiviert ist.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75