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.

Sign up for GitHub

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

Jump to bottom

Improve documentation generation #2465

Merged
merged 3 commits into from
Feb 14, 2024
Merged

Improve documentation generation #2465

merged 3 commits into from
Feb 14, 2024

Commits on Feb 14, 2024

  1. Load the sphinx rtd theme properly 

    The right way to use it is to let sphinx load it as extension. Importing it
directly leads to weird issues.
    @Vogtinator
    Vogtinator committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    6acb2bf View commit details
    Browse the repository at this point in the history

  2. Allow newer versions of sphinx again 

    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
    Vogtinator committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    7353327 View commit details
    Browse the repository at this point in the history

  3. Remove custom.css from the documentation 

    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 committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    74b881f View commit details
    Browse the repository at this point in the history