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

Merged
merged 4 commits into from Jan 11, 2018

Conversation

Projects
None yet
2 participants
@ericholscher
Member

ericholscher commented Jan 9, 2018

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.

ericholscher added some commits Jan 9, 2018

Stop running Mkdocs JSON builder
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/

@ericholscher ericholscher changed the title from Add david to Dev team listing to Stop running Mkdocs JSON builder Jan 9, 2018

@ericholscher ericholscher changed the title from Stop running Mkdocs JSON builder to Remove our mkdocs search override Jan 9, 2018

@ericholscher ericholscher requested review from humitos and agjohnson Jan 9, 2018

@humitos

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.

@humitos

humitos Jan 11, 2018

Member

Since we are not using it we can also comment line 4 (require)

@ericholscher

This comment has been minimized.

Member

ericholscher commented Jan 11, 2018

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.

@humitos

This comment has been minimized.

Member

humitos commented Jan 11, 2018

@ericholscher

This comment has been minimized.

Member

ericholscher commented Jan 11, 2018

Their own search works fine, thats what this PR is for :)

@humitos

This comment has been minimized.

Member

humitos commented Jan 11, 2018

@ericholscher ericholscher merged commit 735d630 into master Jan 11, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@stsewd stsewd deleted the stop-running-mkdocs-json branch Aug 15, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment