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

Improve documentation generation #2465

Merged
merged 3 commits into from
Feb 14, 2024
Merged

Conversation

Vogtinator
Copy link
Collaborator

  • Load the sphinx rtd theme properly
    *Allow newer versions of sphinx again
    *Remove custom.css from the documentation

Fixes #2462

The right way to use it is to let sphinx load it as extension. Importing it
directly leads to weird issues.
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
This css file hasn't been compatible with the generated content for a while,
leading to 404 errors for "hierarchy_arrow.gif" and causing layout issues.

Just remove it to get rid of the 404 and improve the appearance noticably.
@Vogtinator Vogtinator mentioned this pull request Feb 14, 2024
@schaefi schaefi merged commit 765c5a5 into OSInside:main Feb 14, 2024
14 of 15 checks passed
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.

Switch to new sphinx
2 participants