icon_links is required even if empty?

[choldgraf]

I've heard reports that this theme will now error if icon_links is not given in conf.py, and users must set it to an empty list to avoid this error. Has anybody else experienced this?

Here's where we check icon_links:

pydata-sphinx-theme/src/pydata_sphinx_theme/__init__.py

Line 91 in 2d245c9

if not isinstance(theme_options.get("icon_links", []), list):

[janash]

Yes, I have experienced this.

[hakonanes]

I just got the following traceback from a Read The Docs build using Python 3.9 and PyData Sphinx Theme 0.13:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/sphinx/events.py", line 94, in emit
    results.append(listener.handler(self.app, *args))
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/pydata_sphinx_theme/__init__.py", line 202, in update_config
    theme_options["icon_links"].insert(
KeyError: 'icon_links'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/sphinx/application.py", line 262, in __init__
    self._init_builder()
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/sphinx/application.py", line 335, in _init_builder
    self.events.emit('builder-inited')
  File "/home/docs/checkouts/readthedocs.org/user_builds/orix/envs/433/lib/python3.9/site-packages/sphinx/events.py", line 105, in emit
    raise ExtensionError(__("Handler %r for event %r threw an exception") %
sphinx.errors.ExtensionError: Handler <function update_config at 0x7f1ec55cc4c0> for event 'builder-inited' threw an exception (exception: 'icon_links')

Extension error (pydata_sphinx_theme):
Handler <function update_config at 0x7f1ec55cc4c0> for event 'builder-inited' threw an exception (exception: 'icon_links')

Is this the error in question?

[hakonanes]

Sorry, just saw #1220. So the answer is yes, I see this as well...

[lwasser]

i am getting this too - also getting a warning from Jupyter i think?

WARNING: `footer_items` is deprecated. Use `footer_start` or `footer_end` instead.

setting icon_links = [] does not work for me but could also be user error! happy to test things if more information is helpful.

Handler <function update_config at 0x1472534c0> for event 'builder-inited' threw an exception (exception: 'icon_links')

UPDATE: i do see i may need to update our footer info in conf.py hence the warning! so the icon_links is the only bug that i see :) pinning to v0.12 in Ci is working well!