ESMCI/doc-builder

Clean up path in Sphinx complaint messages when using container

Aperta

#39 aperta il 10 apr 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (2 fork)auto 404
featuregood first issue

Metriche repository

Star
 (0 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Individua il codice in doc builder che stampa i messaggi di avviso di Sphinx e modificalo per rimuovere il percorso di montaggio del contenitore (es. '/home/user/mounted home/') quando la modalità verbose è disattivata.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75