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

A hack to fix broken search bar in doc #2583

Merged
merged 1 commit into from
Sep 27, 2017

Conversation

hcho3
Copy link
Collaborator

@hcho3 hcho3 commented Aug 6, 2017

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:

  • Download searchtools.js to your home folder.
  • Run python -m SimpleHTTPServer.
  • Open the web browser and browse to http://localhost:8000/searchtools.js
    Make sure that you can access the script using this address.
  • Download the Google Chrome extension Resource Override.
    This will let you subtitute the custom script for the hosted script.
  • Set following the replacement rule in Resource Override:
   https://xgboost.readthedocs.io/en/latest/_static/searchtools.js
=> http://localhost:8000/searchtools.js

screen shot 2017-08-05 at 6 30 37 pm

  • The search function should work with the custom script loaded.

screen shot 2017-08-05 at 6 31 56 pm

  • Once done, make sure to delete the Google Chrome extension and shut down SimpleHTTPServer.

@hcho3 hcho3 force-pushed the temp_fix_search branch from d89165f to c52d7ed Compare August 6, 2017 01:34
@hcho3 hcho3 changed the title A hack to fix broken search bar A hack to fix broken search bar in doc Aug 6, 2017
@hcho3 hcho3 force-pushed the temp_fix_search branch 2 times, most recently from 2b38438 to f4c33f4 Compare August 6, 2017 01:36
@hcho3
Copy link
Collaborator Author

hcho3 commented Aug 6, 2017

@ysh329 This might be an interest to you.

@ysh329
Copy link

ysh329 commented Aug 6, 2017

@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.
@hcho3 hcho3 force-pushed the temp_fix_search branch from f4c33f4 to 86bf591 Compare August 6, 2017 01:41
@codecov-io
Copy link

codecov-io commented Aug 6, 2017

Codecov Report

Merging #2583 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
src/data/sparse_page_dmatrix.cc 87.97% <0%> (+1.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70b65a2...86bf591. Read the comment docs.

Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

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

Thanks!

@terrytangyuan terrytangyuan merged commit 0eaf43a into dmlc:master Sep 27, 2017
@terrytangyuan terrytangyuan self-assigned this Sep 27, 2017
CodingCat pushed a commit to CodingCat/xgboost that referenced this pull request Dec 29, 2017
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.
@hcho3 hcho3 deleted the temp_fix_search branch February 21, 2018 19:04
@lock lock bot locked as resolved and limited conversation to collaborators Jan 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants