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

Documentation interactivity is broken in /en/latest #3193

Closed
astrojuanlu opened this issue Oct 18, 2023 · 1 comment
Closed

Documentation interactivity is broken in /en/latest #3193

astrojuanlu opened this issue Oct 18, 2023 · 1 comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed

Comments

@astrojuanlu
Copy link
Member

Description

@vladimir-mck noted that there is a Uncaught ReferenceError: jQuery is not defined error, and it turns out it's affecting https://docs.kedro.org/en/latest/, but not https://docs.kedro.org/en/stable/. This makes the hamburger menu to not work (only visible in small viewports), as well as the RTD flyout.

I am not sure what changed, but the source code of /en/stable is loading jQuery:

<script src="_static/jquery.js"></script>

whereas /en/latest isn't.

I've heard of jQuery being dropped from Sphinx, sphinx-rtd-theme, etc at various points (sphinx-doc/sphinx#7405, readthedocs/sphinx_rtd_theme#1253) but I haven't had time to debug whether this affected us or not.

In the meantime, maybe it's worth trying to add it back https://pypi.org/project/sphinxcontrib-jquery/ or find some other solution. Beware of readthedocs/sphinx_rtd_theme#1452.

@astrojuanlu astrojuanlu added Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed labels Oct 18, 2023
@astrojuanlu astrojuanlu mentioned this issue Oct 18, 2023
7 tasks
@astrojuanlu
Copy link
Member Author

Fixed directly in #3192

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed
Projects
Archived in project
Development

No branches or pull requests

1 participant