ESMCI / ESMCI/doc-builder

Clean up path in Sphinx complaint messages when using container

Open
#39 0 comments 0 reactions 0 assignees View on GitHub
feature good first issue
Dominant language
Python
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

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

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.