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

fix: pin Sphinx version #1511

Merged
merged 1 commit into from
Sep 22, 2023
Merged

fix: pin Sphinx version #1511

merged 1 commit into from
Sep 22, 2023

Conversation

kai687
Copy link
Owner

@kai687 kai687 commented Sep 22, 2023

In Sphinx 7, copying the static assets happens BEFORE the doctree-resolved event is emitted.
Because we update the globalcontext with the DocSearch configuration when handling this event, the docsearch_config.js file ends up empty. DocSearch is NOT being added.

In Sphinx 6, copying the static files happens AFTER the doctree-resolved event is emitted.
The global context has the DocSearch configuration, the docsearch_config.js file is NOT empty, and DocSearch works as expected.

Properly supporting the latest version of Sphinx is a bit of a challenge due to the many expected and unexpected changes. Until I figure it out, I won't support Sphinx 7.

@netlify
Copy link

netlify bot commented Sep 22, 2023

Deploy Preview for sphinxawesome-theme ready!

Name Link
🔨 Latest commit 9da2148
🔍 Latest deploy log https://app.netlify.com/sites/sphinxawesome-theme/deploys/650dd6112e6588000898694c
😎 Deploy Preview https://deploy-preview-1511--sphinxawesome-theme.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance:
Accessibility:
Best Practices:
SEO:
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@kai687 kai687 merged commit 4585d87 into main Sep 22, 2023
8 checks passed
@kai687 kai687 deleted the fix/pin-sphinx-6 branch September 22, 2023 18:01
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

1 participant