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 search is currently broken #12181

Closed
sairuk opened this issue Mar 25, 2024 · 2 comments
Closed

Documentation search is currently broken #12181

sairuk opened this issue Mar 25, 2024 · 2 comments
Assignees
Labels
docs Documentation-related issues

Comments

@sairuk
Copy link
Contributor

sairuk commented Mar 25, 2024

MAME version

0.263

System information

docs.mamedev.org

Accessed through Firefox 120, although this is an upstream issue with the rtd project.

INI configuration details

No response

Emulated system/software

No response

Incorrect behaviour

Searching documentation on docs.mamedev.org does not complete instead reporting errors to the js console in developer tools

Uncaught ReferenceError: jQuery is not defined
    <anonymous> https://docs.mamedev.org/search.html?q=test&check_keywords=yes&area=default:129
search.html:129:7
Uncaught ReferenceError: jQuery is not defined
    <anonymous> https://docs.mamedev.org/search.html?q=test&check_keywords=yes&area=default:134
search.html:134:5

Expected behaviour

Users are able to successfully search documentation

Steps to reproduce

No response

Additional details

This appears to be an upstream issue with the sphinx_rtd_theme (half) removing jquery support readthedocs/sphinx_rtd_theme#1546 other projects appear to have implemented workarounds, raising this for visibility on both projects.

@Firehawke Firehawke self-assigned this Apr 3, 2024
@Firehawke Firehawke added the docs Documentation-related issues label Apr 3, 2024
@Firehawke
Copy link
Contributor

Assigning this to myself and monitoring the RTD issue to see how they intend to handle this.

@Firehawke
Copy link
Contributor

It doesn't look like RTD is going to fix their botched 2.0.0 release any time soon. There are a number of other smaller things I'd noticed that were concerning in 2.0.0, but the broken search was the primary problem. I've replaced the JQuery call on our local RTD version with a standard script tag, which is what I expect that the final upstream solution will be.

Search is functional again. I'm going to need to make a note to keep an eye out for future RTD/Sphinx updates to TRY to avoid breakages like this from happening again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
Development

No branches or pull requests

2 participants