Skip to content

[docs] Pin myst-parser~=4.0#4626

Merged
geoffreynyaga merged 4 commits into
mainfrom
bugfix/docs-fix-sphinx-build-error
Jan 21, 2026
Merged

[docs] Pin myst-parser~=4.0#4626
geoffreynyaga merged 4 commits into
mainfrom
bugfix/docs-fix-sphinx-build-error

Conversation

@xmkg

@xmkg xmkg commented Jan 21, 2026

Copy link
Copy Markdown
Member

sphinx-tabs < 3.4.5 raises KeyError: 'backrefs' with Sphinx 8.x due to changes in node attribute handling.

Also, add freedesktop.org to the linkcheck ignore list.

sphinx-tabs < 3.4.5 raises KeyError: 'backrefs' with Sphinx 8.x due to
changes in node attribute handling.

Signed-off-by: Mustafa Kemal Gilor <mustafa.gilor@canonical.com>
@xmkg xmkg force-pushed the bugfix/docs-fix-sphinx-build-error branch from 85ceac1 to d3bf2ca Compare January 21, 2026 11:31
@xmkg xmkg changed the title [docs] Pin sphinx-tabs>=3.4.5 [docs] Pin sphinx<8.0 Jan 21, 2026
@xmkg xmkg requested a review from geoffreynyaga January 21, 2026 11:35
Signed-off-by: Mustafa Kemal Gilor <mustafa.gilor@canonical.com>
@xmkg xmkg force-pushed the bugfix/docs-fix-sphinx-build-error branch from b1b7c33 to 27abbd5 Compare January 21, 2026 11:46
Freedesktop has started to return 418 - I'm a teapot for the requests
coming from the GH infra. This might be due to the fact that GH infra
could be sharing the IP blocks with the ChatGPT (or other LLM crawlers)

Signed-off-by: Mustafa Kemal Gilor <mustafa.gilor@canonical.com>
@xmkg xmkg force-pushed the bugfix/docs-fix-sphinx-build-error branch from 44dea41 to 2f009fe Compare January 21, 2026 11:55
@xmkg xmkg marked this pull request as ready for review January 21, 2026 11:58
@geoffreynyaga

geoffreynyaga commented Jan 21, 2026

Copy link
Copy Markdown
Contributor

@xmkg

This is an issue affecting many documentation sets across Canonical. We have already raised an issue on Multipass #4619
The root cause is an external python package (myst-parser) was updated to version 5 on Jan 15th 2026. This is what makes the sphinx-tabs extension to fail.

Below are the recommended fixes:

  1. There is a short term fix to pin down the myst-parser to version 4.0 in the requirements.txt file. This is already being implemented in the main starter pack repo.
  2. Since the current tabs extension is no longer supported, its recommended to migrate to the sphinx-design tabs extension instead. We have already created this PR for Multipass. Other similar projects to implement this is the k8s-snap repo, also see this MM thread

Signed-off-by: Mustafa Kemal Gilor <mustafa.gilor@canonical.com>
@xmkg xmkg changed the title [docs] Pin sphinx<8.0 [docs] Pin myst-parser~=4.0 Jan 21, 2026

@geoffreynyaga geoffreynyaga left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @xmkg. Approved!

@geoffreynyaga geoffreynyaga added this pull request to the merge queue Jan 21, 2026
@geoffreynyaga geoffreynyaga self-assigned this Jan 21, 2026
Merged via the queue into main with commit ed15881 Jan 21, 2026
10 checks passed
@geoffreynyaga geoffreynyaga deleted the bugfix/docs-fix-sphinx-build-error branch January 21, 2026 13:33
geoffreynyaga added a commit that referenced this pull request Feb 23, 2026
sphinx-tabs < 3.4.5 raises KeyError: 'backrefs' with Sphinx 8.x due to
changes in node attribute handling.

Also, add freedesktop.org to the linkcheck ignore list.
geoffreynyaga added a commit that referenced this pull request Apr 22, 2026
sphinx-tabs < 3.4.5 raises KeyError: 'backrefs' with Sphinx 8.x due to
changes in node attribute handling.

Also, add freedesktop.org to the linkcheck ignore list.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants