search

matplotlib / mpl-third-party

Third-party Packages Webpage
https://matplotlib.org/mpl-third-party/
53 stars 71 forks source link

html_permalinks_icon key error in GitHub pages builds #121

Closed jack89roberts closed 2 years ago

jack89roberts commented 2 years ago

Since #112 it looks like the GitHub pages builds have been failing with a html_permalinks_icon key error (which means the last 4 tools to be merged (microfilm, tueplots, grplot and distinctipy) are not appearing on the docs page.

E.g. see this latest build: https://github.com/matplotlib/mpl-third-party/runs/7224799482?check_suite_focus=true

Exception occurred:
  File "/usr/local/lib/python3.8/site-packages/pydata_sphinx_theme/__init__.py", line 45, in update_config
    icon_default = app.config.values["html_permalinks_icon"]
KeyError: 'html_permalinks_icon'
The full traceback has been saved in /tmp/sphinx-err-kzajtp7a.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:21: html] Error 2
Traceback (most recent call last):
  File "/entrypoint.py", line 22, in <module>
    action.build_all_docs(github_env, [os.environ.get("INPUT_DOCS-FOLDER")])
  File "/sphinx_action/action.py", line 167, in build_all_docs
    raise RuntimeError("Build failed")
RuntimeError: Build failed
QuLogic commented 2 years ago

The problem is partially that pydata-sphinx-theme 0.9.0 is too new, but even pinning that, we have:

ERROR: pydata-sphinx-theme 0.8.1 has requirement sphinx<5,>=3.5.4, but you'll have sphinx 2.4.4 which is incompatible.

This is because ammaraskar/sphinx-action uses Sphinx 2.4.4 and pip does not upgrade it as a transitive dependency. I think if we add that minimum to requirements.txt explicitly, then pip will upgrade it. Alternatively, we could fork the action and upgrade it; I'm not sure if we use this action in multiple places to justify that.

jklymak commented 2 years ago

I don't think I set that action up, but if I did, I would have just googled for it - if there is some more apropos action we should use that instead.

QuLogic commented 2 years ago

I would do the same; it appears to be the top Google result. I don't know if there are any better alternatives.

Though I guess another alternative is to just do it manually; setup-python action + pip install which should work, I think?

QuLogic commented 2 years ago

Though I guess another alternative is to just do it manually; setup-python action + pip install which should work, I think?

It's only 3 steps, so I just went ahead and did that in #123