The publish-docs job fails on every push to main: https://github.com/E3SM-Project/zppy-interfaces/actions/runs/31208671038
File ".../sphinx_multiversion/main.py", line 88, in load_sphinx_config
TypeError: Config.read() takes 2 positional arguments but 3 were given
sphinx-multiversion 0.2.4 calls Config.read(confdir, confoverrides, add_defaults=True). Sphinx 8.1 deprecated those extra arguments and Sphinx 9.0 removed them.
sphinx is unpinned in conda/dev.yml and pyproject.toml, and CI solves the environment fresh, so this appeared on its own:
Unrelated to the PR that happened to trigger the failing run (#53) — any push to main fails the same way. publish-docs only runs on push/workflow_dispatch (build_workflow.yml:114), so it is never exercised on PR branches.
Short-term fix
Pin sphinx<9 in both conda/dev.yml and the docs extra in pyproject.toml.
Longer term
sphinx-multiversion has had no release since 2021, so the pin only holds until something else needs Sphinx 9+. Migrating to a maintained multi-version builder (e.g. sphinx-polyversion) would be the real fix.
The
publish-docsjob fails on every push tomain: https://github.com/E3SM-Project/zppy-interfaces/actions/runs/31208671038sphinx-multiversion0.2.4 callsConfig.read(confdir, confoverrides, add_defaults=True). Sphinx 8.1 deprecated those extra arguments and Sphinx 9.0 removed them.sphinxis unpinned inconda/dev.ymlandpyproject.toml, and CI solves the environment fresh, so this appeared on its own:Unrelated to the PR that happened to trigger the failing run (#53) — any push to
mainfails the same way.publish-docsonly runs onpush/workflow_dispatch(build_workflow.yml:114), so it is never exercised on PR branches.Short-term fix
Pin
sphinx<9in bothconda/dev.ymland thedocsextra inpyproject.toml.Longer term
sphinx-multiversionhas had no release since 2021, so the pin only holds until something else needs Sphinx 9+. Migrating to a maintained multi-version builder (e.g.sphinx-polyversion) would be the real fix.