Skip to content

Conversation

@Debsmita2005G
Copy link

Fixes #6071

This PR fixes the Sphinx warning:

WARNING: html_static_path entry 'source/_static' is placed inside outdir

The warning occurred because html_static_path in conf.py was pointing to source/_static,
which Sphinx considered inside the output directory. It has been updated to:

html_static_path = ['_static']

After this change, the documentation builds successfully without warnings, and
HTML pages are generated in build/html. This change only fixes the Sphinx configuration;
it does not modify any documentation content.
Did you use Generative AI?
no
Additional information none

Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i tries already because Claude suggested me before, but it does not work. (the error stays even if i moved the _static directory one up.) did you successfully make lint and build the documentation?

rosindex@f34850e3d855:/tmp/doc_repository$ git diff
diff --git a/conf.py b/conf.py
index 0532287d..7a2388e2 100644
--- a/conf.py
+++ b/conf.py
@@ -172,7 +172,7 @@ html_favicon = 'favicon.ico'
 # Add any paths that contain custom static files (such as style sheets) here,
 # 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 = ['source/_static']
+html_static_path = ['_static']
 
 # Drop any source link suffix
 html_sourcelink_suffix = ''
rosindex@f34850e3d855:/tmp/doc_repository$ make lint
./sphinx-lint-with-ros source
WARNING: html_static_path entry '_static' does not exist
WARNING: html_static_path entry '_static' does not exist
...

@fujitatomoya
Copy link
Collaborator

@Debsmita2005G i think you accidentally pushed the unrelated files from venv?

@Debsmita2005G Debsmita2005G force-pushed the fix-html-static-warning branch from 0041b61 to 86bf022 Compare December 12, 2025 04:11
@Debsmita2005G
Copy link
Author

I'm working on it........

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 WARNING: html_static_path entry 'source/_static' is placed inside outdir

2 participants