Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upRemove our mkdocs search override #3496
Conversation
ericholscher
added some commits
Jan 9, 2018
ericholscher
changed the title from
Add david to Dev team listing
to
Stop running Mkdocs JSON builder
Jan 9, 2018
ericholscher
changed the title from
Stop running Mkdocs JSON builder
to
Remove our mkdocs search override
Jan 9, 2018
ericholscher
requested review from
humitos and
agjohnson
Jan 9, 2018
humitos
approved these changes
Jan 11, 2018
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(); |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
ericholscher
Jan 11, 2018
Member
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.
|
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. |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
humitos
Jan 11, 2018
Member
|
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" <notifications@github.com>
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>
.
|
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
|
Their own search works fine, thats what this PR is for :) |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
humitos
Jan 11, 2018
Member
|
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>
.
|
ericholscher commentedJan 9, 2018
•
edited
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.