skpro: [BUG] sphinx build failures with json parse error

The sphinx doc build seems to fail with json parse errors.

I don’t think anything was changed that would cause this, it’s a bit mysterious.

My suspicion is, based on it being the only json file in the docs afaik, the file docs/source/_static/switcher.json, but all seems ok there?

FYI @yarnabrina, @duydl, in case you have any quick spots.

About this issue

Original URL
State: open
Created 3 months ago
Comments: 20 (1 by maintainers)

Commits related to this issue

Revert "[MNT] point readthedocs `json` switcher variable to GitHub" (#225) Reverts sktime/skpro#125 Experimental, upon suggestion of @duydl in https://github.com/sktime/skpro/issues/224 — committed to sktime/skpro by fkiraly 3 months ago

Most upvoted comments

https://github.com/sktime/skpro/pull/225#issuecomment-2027339709

The problem was that after manually modifying the json to add a new version, this change would not be visible on the branch, because the json_url pointed to main.

i dont think it would introduce issue. While the changes in switcher not visible in PR or branch, it would still update correctly in release version. Also it have an added benefit that all legacy docs have the dropdown pointing to all available versions.

duydl on Mar 29, 2024

It is not quite a quick spot but the error is because https://github.com/sktime/skpro/blob/main/docs/source/conf.py#L148

sphinx doesn’t get the json file but the whole HTML page so there is parse json error. On the other hand, I am not sure how builds so far could have passed. json_url must be overwritten somehow: https://github.com/sktime/skpro/blob/main/docs/source/conf.py#L162 .

L148 is edited in #125 to fix #122 but why don’t just point it to the _static/switcher.json?

duydl on Mar 29, 2024