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

Fix missing jQuery error in docs #1321

Merged
merged 3 commits into from
Aug 10, 2023

Conversation

AyodeAwe
Copy link
Contributor

@AyodeAwe AyodeAwe commented Aug 7, 2023

The latest versions 4.1 and 4.0 of sphinxcontrib-jquery have an issue with jQuery installed currently in sphinx. This is causing the search functionality to fail so I've pinned the version to 3.0.0, this resolves the issue.

@AyodeAwe AyodeAwe added non-breaking Non-breaking change improvement Improvement / enhancement to an existing function ci labels Aug 7, 2023
@AyodeAwe AyodeAwe requested a review from a team as a code owner August 7, 2023 20:30
@github-actions github-actions bot added conda and removed ci labels Aug 7, 2023
Copy link
Member

@jakirkham jakirkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jake! 🙏

@bdice
Copy link
Contributor

bdice commented Aug 7, 2023

Is this the source of the issue? readthedocs/sphinx_rtd_theme#1452

@AyodeAwe
Copy link
Contributor Author

AyodeAwe commented Aug 7, 2023

Yep @bdice, seems like it

@AyodeAwe
Copy link
Contributor Author

AyodeAwe commented Aug 7, 2023

The suggested fix here works but not without throwing a new error Uncaught ReferenceError: _ is not defined

@bdice
Copy link
Contributor

bdice commented Aug 7, 2023

Ok. FYI @vyasr if you migrate RMM's C++ docs to use Sphinx/Breathe, we might also want to update the Sphinx theme to match the same one used for cudf/cuml/etc.

Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to confirm locally that the suggested workaround isn't sufficient before we merge this.

It'd be better if we didn't have to introduce additional dependencies.

@ajschmidt8
Copy link
Member

The suggested fix here works but not without throwing a new error Uncaught ReferenceError: _ is not defined

I was able to confirm that this workaround resolves the issue locally without causing other problems.

Unfortunately this isn't something we'll be able to confirm in CI, as it appears that query parameters break our preview environments (a separate issue that we'll have to look into): https://downloads.rapids.ai/ci/rmm/pull-request/1321/3c3dfb6/docs/rmm/html/search/?q=allocator&check_keywords=yes&area=default#

However I think we should be fine with dropping the extra dependency and using the workaround that they've suggested.

@bdice
Copy link
Contributor

bdice commented Aug 7, 2023

I was able to confirm that this workaround resolves the issue locally without causing other problems.

@ajschmidt8 I'm a bit unsure exactly which piece of that thread helped you. That thread has a few things, like setting extensions and html_theme_path. Did you do one or both of those? Were you testing with (or without) the sphinxcontrib-jquery package (if so, which version)? Might be easiest just to push to this PR if @AyodeAwe is okay with that.

@AyodeAwe AyodeAwe requested a review from a team as a code owner August 10, 2023 17:57
@github-actions github-actions bot added Python Related to RMM Python API and removed conda labels Aug 10, 2023
@ajschmidt8
Copy link
Member

I was able to confirm that this workaround resolves the issue locally without causing other problems.

@ajschmidt8 I'm a bit unsure exactly which piece of that thread helped you. That thread has a few things, like setting extensions and html_theme_path. Did you do one or both of those? Were you testing with (or without) the sphinxcontrib-jquery package (if so, which version)? Might be easiest just to push to this PR if @AyodeAwe is okay with that.

I quoted the solution that worked for me. It was this one, which Jake has just added to his PR: readthedocs/sphinx_rtd_theme#1452 (comment)

@ajschmidt8
Copy link
Member

before we merge, I will just pull the docs from S3 and check the fix locally so that we can be certain it's working as expected.

we'll look into that query parameter issue that I mentioned another time

@ajschmidt8
Copy link
Member

confirmed. merging

@ajschmidt8
Copy link
Member

/merge

@ajschmidt8
Copy link
Member

ah, this incident is probably preventing the /merge command from working: https://www.githubstatus.com/incidents/rk1918knvr0w

I'll just squash merge manually for now.

@ajschmidt8 ajschmidt8 merged commit 663e659 into rapidsai:branch-23.10 Aug 10, 2023
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement / enhancement to an existing function non-breaking Non-breaking change Python Related to RMM Python API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants