-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Remove our mkdocs search override #3496
Conversation
This has been removed from mkdocs, so we should stop running it. It will fix the error here: http://readthedocs.org/projects/mkdocs/builds/6503359/
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.
LGTM. I just left a minor comment. Check the conflicts on the js file.
I didn't test the mkdocs builtin search (not the search itself, but that the url of the form is correct for example). I suppose that you did and work :)
This is a temporary fix, but will at least make search work.
We should create an issue to track this: go back to our better mkdocs search engine, at some point.
@@ -10,6 +10,6 @@ $(document).ready(function () { | |||
footer.init(); | |||
sphinx.init(); | |||
// grokthedocs.init(); | |||
mkdocs.init(); | |||
// mkdocs.init(); |
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.
Since we are not using it we can also comment line 4 (require
)
There's already a million tickets about mkdocs search not being great. They removed the json command that we were using for search on our side, so I'm not sure if "proper" search for mkdocs is going to happen. |
Yes, I understand that but if their own search doesn't work either I think
it's preferable to remove the search completely from mkdocs to avoid
another tons of issues.
El 11 ene. 2018 11:15 a. m., "Eric Holscher" <[email protected]>
escribió:
There's already a million tickets about mkdocs search not being great. They
removed the json command that we were using for search on our side, so I'm
not sure if "proper" search for mkdocs is in the cards.
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#3496 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAO7sECtXrTHlvrmZ_3pqHJg4nbD6Dwvks5tJjOKgaJpZM4RYdB8>
.
|
Their own search works fine, thats what this PR is for :) |
👍
El 11 ene. 2018 11:56 a. m., "Eric Holscher" <[email protected]>
escribió:
… Their own search works fine, thats what this PR is for :)
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#3496 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAO7sBM4EuY2OyzOF6O6pTCgnqGvJXoJks5tJj1MgaJpZM4RYdB8>
.
|
This removes the JSON build on mkdocs,
as this has been removed from mkdocs,
so we should stop running it.
It will fix the error here: http://readthedocs.org/projects/mkdocs/builds/6503359/
It also fixes the search so that it uses mkdocs builtin search, instead of our own broken search for mkdocs. This is a temporary fix, but will at least make search work.