Skip to content

Fix html_static_path warning by using absolute path #6178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
ahcorde merged 3 commits into from
Feb 2, 2026
Merged

Fix html_static_path warning by using absolute path #6178

ahcorde merged 3 commits into from
Feb 2, 2026
+1 −1

Conversation

@Shivam-Bhardwaj
Copy link
Contributor

@Shivam-Bhardwaj Shivam-Bhardwaj commented Jan 21, 2026

Summary

Fixes the Sphinx warning that appears during make lint and make html:

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

Changes

Use os.path.abspath() to convert the relative path to an absolute path:

- html_static_path = ['source/_static']
+ html_static_path = [os.path.abspath('source/_static')]

Testing

  • make html builds without warnings
  • Static files (custom.css) still work correctly

Fixes #6071

Shivam-Bhardwaj and others added 2 commits January 20, 2026 20:28
@Shivam-Bhardwaj
Fix html_static_path warning by using absolute path (ros2#6071)
13ce970 
Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'
@kscottz
Merge branch 'rolling' into fix/issue-6071-static-path-warning
d397687
@kscottz
Copy link
Collaborator

kscottz commented Jan 29, 2026 •
edited
Loading

@Shivam-Bhardwaj I just checked out rolling and ran make html and make lint and I didn't see the error you mentioned. Can you explain a bit more what's happening here?

My bad, I missed this original issue. This PR caused me no problems when I tested it. I'll approve.

kscottz
kscottz approved these changes Jan 29, 2026
View reviewed changes
Copy link
Collaborator

@kscottz kscottz left a comment

Choose a reason for hiding this comment

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

Worked in my local environment. Let's give it a try.

@christophebedard christophebedard added the backport-all backport at reviewers discretion; from rolling to all versions label Jan 29, 2026
@ahcorde ahcorde merged commit cbad944 into ros2:rolling Feb 2, 2026
6 checks passed
mergify bot pushed a commit that referenced this pull request Feb 2, 2026
@Shivam-Bhardwaj @kscottz
@ahcorde @mergify
Fix html_static_path warning by using absolute path (#6071) (#6178)
a6acc3d 
Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'

Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
(cherry picked from commit cbad944)
@mergify mergify bot mentioned this pull request Feb 2, 2026
Merged
2 tasks
mergify bot pushed a commit that referenced this pull request Feb 2, 2026
@Shivam-Bhardwaj @kscottz
@ahcorde @mergify
Fix html_static_path warning by using absolute path (#6071) (#6178)
9ff2bb5 
Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'

Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
(cherry picked from commit cbad944)
@mergify mergify bot mentioned this pull request Feb 2, 2026
Merged
2 tasks
mergify bot pushed a commit that referenced this pull request Feb 2, 2026
@Shivam-Bhardwaj @kscottz
@ahcorde @mergify
Fix html_static_path warning by using absolute path (#6071) (#6178)
e948862 
Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'

Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
(cherry picked from commit cbad944)
@mergify mergify bot mentioned this pull request Feb 2, 2026
Merged
2 tasks
ahcorde added a commit that referenced this pull request Feb 2, 2026
@mergify @Shivam-Bhardwaj
@kscottz @ahcorde
Fix html_static_path warning by using absolute path (#6071) (#6178) (#…
5075d40 
…6204)

Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'



(cherry picked from commit cbad944)

Co-authored-by: Shivam <curious.antimony@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
ahcorde added a commit that referenced this pull request Feb 2, 2026
@mergify @Shivam-Bhardwaj
@kscottz @ahcorde
Fix html_static_path warning by using absolute path (#6071) (#6178) (#…
d535e40 
…6205)

Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'



(cherry picked from commit cbad944)

Co-authored-by: Shivam <curious.antimony@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
ahcorde added a commit that referenced this pull request Feb 2, 2026
@mergify @Shivam-Bhardwaj
@kscottz @ahcorde
Fix html_static_path warning by using absolute path (#6071) (#6178) (#…
11e53f7 
…6206)

Use os.path.abspath() for html_static_path to prevent the Sphinx warning:
'WARNING: html_static_path entry is placed inside outdir'



(cherry picked from commit cbad944)

Co-authored-by: Shivam <curious.antimony@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kscottz kscottz kscottz approved these changes

Assignees

No one assigned

Labels

backport-all backport at reviewers discretion; from rolling to all versions

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

4 participants

@Shivam-Bhardwaj @kscottz @ahcorde @christophebedard