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

Switch to new sphinx #2462

Closed
Vogtinator opened this issue Feb 14, 2024 · 2 comments · Fixed by #2465
Closed

Switch to new sphinx #2462

Vogtinator opened this issue Feb 14, 2024 · 2 comments · Fixed by #2465

Comments

@Vogtinator
Copy link
Collaborator

While working on the documentation I found that sphinx-build always reread and recreated all documentation files, even if nothing changed:

updating environment: 0 added, 96 changed, 0 removed

This was due to broken dependency calculation for python .egg files and was fixed in later versions apparently. After pip install --upgrade sphinx (currently v7.2.6), incremental builds works as expected.

@schaefi
Copy link
Collaborator

schaefi commented Feb 14, 2024

I think I sticked with sphinx v5.0.0 because newer versions broken the rtd theme (no search possible on the page). Also see a2dad89

If you can confirm it does not break the current rtd theme I'm happy to switch

Vogtinator added a commit to Vogtinator/kiwi that referenced this issue Feb 14, 2024
With Sphinx >= 6.0.0, jQuery is no longer included but the rtd theme's search
functionality needs it. The theme was changed to load sphinxcontrib-jquery
automatically with readthedocs/sphinx_rtd_theme#1399,
but kiwi broke this fix by loading the theme in the wrong way.

Now that the theme is loaded properly, the search functionality also works
with newer versions of sphinx again and the version pinning can be lifted.

Fixes: OSInside#2462
@Vogtinator
Copy link
Collaborator Author

It did break the search functionality, but I fixed that and some more issues: #2465

schaefi pushed a commit that referenced this issue Feb 14, 2024
With Sphinx >= 6.0.0, jQuery is no longer included but the rtd theme's search
functionality needs it. The theme was changed to load sphinxcontrib-jquery
automatically with readthedocs/sphinx_rtd_theme#1399,
but kiwi broke this fix by loading the theme in the wrong way.
Now that the theme is loaded properly, the search functionality also works
with newer versions of sphinx again and the version pinning can be lifted.
This Fixes: #2462
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 a pull request may close this issue.

2 participants