Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

plugins/Sphinx: Work around Sphinx using new config format #48

Merged
merged 2 commits into from Apr 25, 2024

Conversation

SmithChart
Copy link
Member

Since Sphinx 7.3.0 they use a new toml-based config format for the theme configuration. See:
sphinx-doc/sphinx#12265

This breaks how the Flamingo Sphinx plugin handles the theme configuration.
With this change we pin Sphinx to a version <7.3.0 to work around this issue until we have a proper fix.

Also: Update changelog and bump version for a new release.

Since Sphinx 7.3.0 they use a new toml-based config format for the theme
configuration. See:
sphinx-doc/sphinx#12265

This breaks how the Flamingo Sphinx plugin handles the theme
configuration.

With this change we pin Sphinx to a version <7.3.0 to work around this
issue until we have a proper fix.

Signed-off-by: Chris Fiege <cfi@pengutronix.de>
Signed-off-by: Chris Fiege <cfi@pengutronix.de>
@SmithChart SmithChart self-assigned this Apr 22, 2024
@Bastian-Krause
Copy link
Member

Some notes from internal discussion with @SmithChart:

  • Sphinx supports both ini and toml configs, but the Sphinx-internal configs flamingo parses were converted to toml (we should investigate if there's a better way than parsing these ourselves).
  • We don't have test coverage for the theme config parsing, this failed for the docs jobs, though.

Copy link
Member

@Bastian-Krause Bastian-Krause left a comment

Choose a reason for hiding this comment

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

Seems to be the easiest way to unbrick flamingo at the moment.

@SmithChart SmithChart merged commit b266b4a into pengutronix:master Apr 25, 2024
7 checks passed
@SmithChart SmithChart deleted the sphinx-fix-release branch April 25, 2024 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants