WARNING: html_static_path entry 'source/_static' is placed inside out…#6345
Merged
WARNING: html_static_path entry 'source/_static' is placed inside out…#6345
Conversation
…dir. Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com>
fujitatomoya
added
the
backport-all
fujitatomoya
commented
Apr 7, 2026
| # relative to this directory. They are copied after the builtin static files, | ||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||
| html_static_path = [os.path.abspath('source/_static')] | ||
| html_static_path = ['source/_static'] |
Collaborator
Author
There was a problem hiding this comment.
this can be rolled back to simple path declaration to source/_static, the previous PRs tried to address the issue is not against the root cause. and probably not verified on the devcontainer environment.
3 tasks
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/24066919418/artifacts/6299849829. To view the resulting site:
|
ahcorde
approved these changes
Apr 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…dir.
Description
the root cause was never about html_static_path resolution, it was the devcontainer workspace mount point.
with the workspace mounted at /tmp/doc_repository, the sphinx outdir (which defaults to something like /tmp/...) would end up encompassing the source tree. sphinx saw that /tmp/doc_repository/source/_static was inside its output directory and warned about it. by moving the workspace mount to /workspaces/doc_repository (the standard devcontainer convention), the source tree is no longer under /tmp/, so there's no path overlap with sphinx's outdir. and reverting html_static_path back to the simple relative 'source/_static' is the right cleanup since the os.path.abspath() wrapper was never helping.
i confirmed and verified this PR with devcontainer and venv, and there was no warning came up.
fixes #6071
replaces #6341 and #6178
Did you use Generative AI?
No
Additional Information
This problem only appears on dev container environment.
#6341 and #6178 tries to close it, but never worked AFAIK.