Skip to content

Commit 815d2ba

Browse files
committed
Rename custom-icon.js to custom-icons.js and update docs
1 parent 0b9a306 commit 815d2ba

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed
File renamed without changes.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@
258258
html_static_path = ["_static"]
259259
html_css_files = ["custom.css"]
260260
html_js_files = [
261-
("custom-icon.js", {"defer": "defer"}),
261+
("custom-icons.js", {"defer": "defer"}),
262262
]
263263
todo_include_todos = True
264264

docs/user_guide/header-links.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ SVG image icons
205205
In order to make use of the full feature set of ``.svg`` images provided by HTML you will need
206206
to set up the ``.svg`` to be used as a FontAwesome type icon. This is a fairly straightforward process:
207207

208-
#. Copy `custom-icon.js <https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/custom-icon.js>`_
208+
#. Copy `custom-icons.js <https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/custom-icons.js>`_
209209
into an appropriate directory of your documentation source (typically ``source/js``). In that file you will
210210
find a list of custom icon definitions. Each definition looks like this:
211211

@@ -237,7 +237,7 @@ to set up the ``.svg`` to be used as a FontAwesome type icon. This is a fairly s
237237
238238
html_js_files = [
239239
...
240-
("js/pypi-icon.js", {"defer": "defer"}),
240+
("js/custom-icons.js", {"defer": "defer"}),
241241
...
242242
]
243243

0 commit comments

Comments
 (0)