Skip to content

Replace PNG with SVG icons in docs - #14577

Merged
pavithraes merged 6 commits into
branch-3.8from
pavithraes/14521-svg-icons-in-docs
Aug 8, 2025
Merged

pavithraes merged 6 commits into
branch-3.8from
pavithraes/14521-svg-icons-in-docs

Conversation

@pavithraes

@pavithraes pavithraes commented Jul 31, 2025 •

Copy link
Copy Markdown
Member

All pull requests must have an associated issue in the issue tracker. If there
isn't one, please go open an issue describing the defect, deficiency or desired
feature. You can read more about our issue and PR processes in the
wiki.

Blocked on: #14563

Comment thread docs/bokeh/Makefile Outdated
Comment thread docs/bokeh/Makefile

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is to ensure the icons in the docs directory are in sync with the ones in bokehjs.

I'm not sure if this is the best approach, but it's the one I was able to test & get working.
While we can copy the icons directly to the build dir, I wasn't able to link to those from the .rst files -- they seem to need relative links or full URLs. Hence, copying files to the source dir. Please let me know if there is an alternative.

@pavithraes
pavithraes marked this pull request as ready for review July 31, 2025 13:45
@mattpap

mattpap commented Aug 1, 2025

Copy link
Copy Markdown
Contributor
/home/runner/miniconda3/envs/bk-test/lib/python3.10/site-packages/bokeh/models/tools.py:docstring of bokeh.models.tools.PolyEditTool:27: WARNING: image file not readable: _images/icons/poly-edit.svg [image.not_readable]
/home/runner/miniconda3/envs/bk-test/lib/python3.10/site-packages/bokeh/models/tools.py:docstring of bokeh.models.tools.PolyEditTool:27: WARNING: image file not readable: _images/icons/poly-edit.svg [image.not_readable]
/home/runner/work/bokeh/bokeh/docs/bokeh/source/docs/user_guide/interaction/tools.rst:1200: WARNING: image file not readable: _images/hover.svg [image.not_readable]
/home/runner/work/bokeh/bokeh/docs/bokeh/source/docs/user_guide/interaction/tools.rst:1244: WARNING: image file not readable: _images/icons/poly-edit.svg [image.not_readable]
/home/runner/work/bokeh/bokeh/docs/bokeh/source/docs/user_guide/interaction/tools.rst:1200: WARNING: image file not readable: _images/hover.svg [image.not_readable]
/home/runner/work/bokeh/bokeh/docs/bokeh/source/docs/user_guide/interaction/tools.rst:1244: WARNING: image file not readable: _images/icons/poly-edit.svg [image.not_readable]

@pavithraes

Copy link
Copy Markdown
Member Author

For poly-edit.svg, I think it should be resolved after #14563 is merged. (I tested it locally)

@mattpap mattpap added this to the 3.9 milestone Aug 7, 2025
@mattpap mattpap modified the milestones: 3.9, 3.8 Aug 8, 2025
@mattpap

mattpap commented Aug 8, 2025 •

Copy link
Copy Markdown
Contributor

@pavithraes, what was the reason to commit copied SVG icons? I removed them in 29119c0. Documentation build fails due to unrelated reasons already fixed in branch-3.8.

@mattpap
mattpap self-requested a review August 8, 2025 09:59
@pavithraes

pavithraes commented Aug 8, 2025 •

Copy link
Copy Markdown
Member Author

what was the reason to commit copied SVG icons?

The icons were not required and shouldn't have been included. Thanks for also updating the gitignore file!

@pavithraes
pavithraes merged commit 735fd6c into branch-3.8 Aug 8, 2025
@pavithraes
pavithraes deleted the pavithraes/14521-svg-icons-in-docs branch August 8, 2025 15:21
@github-actions

Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Nov 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Update docs pages with new SVG icons

2 participants