-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
A hack to fix broken search bar in doc #2583
Conversation
2b38438
to
f4c33f4
Compare
@ysh329 This might be an interest to you. |
@hcho3 Thanks! 👍 |
Current version of xgboost.readthedocs.io has a broken search box. Enabling themes on ReadTheDocs is known to break the search function, as reported in [this document](readthedocs/readthedocs.org#1487). To get around the bug, we replace the `searchtools.js` file with our custom version.
Codecov Report
@@ Coverage Diff @@
## master #2583 +/- ##
==========================================
+ Coverage 35.08% 35.11% +0.02%
==========================================
Files 79 79
Lines 6971 6971
Branches 680 680
==========================================
+ Hits 2446 2448 +2
Misses 4423 4423
+ Partials 102 100 -2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Current version of xgboost.readthedocs.io has a broken search box. Enabling themes on ReadTheDocs is known to break the search function, as reported in [this document](readthedocs/readthedocs.org#1487). To get around the bug, we replace the `searchtools.js` file with our custom version.
Current version of xgboost.readthedocs.io has a broken search box.
Enabling themes on ReadTheDocs is known to break the search function, as reported in this document. To get around the bug, we replace the
searchtools.js
file with our custom version.How to test the custom script before merging this PR:
searchtools.js
to your home folder.python -m SimpleHTTPServer
.Make sure that you can access the script using this address.
This will let you subtitute the custom script for the hosted script.
Google Chrome will warn you about "loading scripts from unauthenticated sources." Click "Load unsafe scripts."
SimpleHTTPServer
.