Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[MRG] DOC Fixed the display of search results (#7517) #7560

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

Merged
merged 2 commits into from
Oct 5, 2016

Conversation

Ajackster
Copy link
Contributor

Reference Issue

#7517

What does this implement/fix? Explain your changes.

Got rid of fixed height for header on desktop views so the search results would expand the page. Kept the fixed height on mobile views so the logo doesn't get squished.

Any other comments?

@nelson-liu
Copy link
Contributor

Thanks for the PR @Ajackster ! I'll be sure to take a look at this once the circle build finishes.

@Ajackster
Copy link
Contributor Author

@nelson-liu Will this be a hot-fix or will this be released on next release?

@nelson-liu
Copy link
Contributor

good question, I'm personally +1 for patching it into the stable docs (we did so when we changed the mailing list address, and I think this is even more important). opinions @amueller @jnothman ?

@Ajackster Ajackster closed this Oct 3, 2016
@Ajackster Ajackster reopened this Oct 3, 2016
@amueller
Copy link
Member

amueller commented Oct 3, 2016

yeah we should totally backport this to 0.18

@nelson-liu
Copy link
Contributor

hmm, not sure why circle is failing here but I pushed these changes to my local fork and the search box seems to disappear. Here's the circleci build (https://circleci.com/gh/nelson-liu/scikit-learn/380) and the associated index.html (https://380-46840245-gh.circle-artifacts.com/0/home/ubuntu/scikit-learn/doc/_build/html/stable/index.html)

@Ajackster
Copy link
Contributor Author

Ajackster commented Oct 3, 2016

@nelson-liu that seems to be an issue with the google api (http) and circleci build (https). scikit-learn.org is just http so it should show up when it is merged into the live site. I don't know if there is a way to make the circleci build http. If you want to see/use the search bar on the circleci build, you will have to allow "unsafe" scripts to be used.
screen shot 2016-10-03 at 4 52 41 pm
screen shot 2016-10-03 at 5 02 13 pm
screen shot 2016-10-03 at 5 02 25 pm

@nelson-liu
Copy link
Contributor

@Ajackster oops I totally forgot that was a thing, that fixed it. I tested it out and it looks good to me. Search was never intended to be on the mobile interface, right?

@Ajackster
Copy link
Contributor Author

Ajackster commented Oct 4, 2016

@nelson-liu not that I am aware of. It didn't seem to be implemented before/after 331964e .
Also, why is this circlici check failing?

@nelson-liu
Copy link
Contributor

Ah ok, just making sure.
I'm not too sure why it's failing either -- it ran successfully on my fork. Maybe push a spurious commit and then remove it to manually force a rebuild?

@lesteve
Copy link
Member

lesteve commented Oct 4, 2016

If you download the full log you'll get this at the very end:

command ./build_tools/circle/build_doc.sh took more than 10 minutes since last output

I triggered a rebuild via the CircleCI interface. One way of doing it yourself is to do git commit --amend and force push.

@Ajackster Ajackster changed the title DOC Fixed the display of search results (#7517) [MRG] DOC Fixed the display of search results (#7517) Oct 5, 2016
@nelson-liu
Copy link
Contributor

looks good to me now

@Ajackster
Copy link
Contributor Author

@lesteve thanks for fixing the circleci build!

Copy link
Member

@lesteve lesteve left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jnothman
Copy link
Member

jnothman commented Oct 5, 2016

It would be nice if the input box and the search button had better alignment, but that's another issue. LGTM

@jnothman jnothman added this to the 0.18.1 milestone Oct 5, 2016
@@ -42,7 +42,6 @@ ul.horizontal, ul.horizontal li {
div.header {
/* for the logo to correctly expand when showing results
Copy link
Member

Choose a reason for hiding this comment

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

This is no longer relevant.

Copy link
Contributor Author

@Ajackster Ajackster Oct 5, 2016

Choose a reason for hiding this comment

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

@jnothman I can get rid of it but I think we should leave a warning message like
div.header { // DON'T ADD A FIXED HEIGHT }
so people don't make the same mistake I did.

Copy link
Member

Choose a reason for hiding this comment

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

Why not but explain why rather than trying to scare people away with all-caps!

@amueller
Copy link
Member

amueller commented Oct 5, 2016

lgtm

@jnothman
Copy link
Member

jnothman commented Oct 5, 2016

I can't say I like how the search results currently display, but this is much better than the broken state! (And I've attempted a hack at the search results so that they overlay but it wasn't as simple as I thought, given interaction with the navbar, the github banner, etc...)

@jnothman jnothman merged commit 1fa3bf7 into scikit-learn:master Oct 5, 2016
@jnothman
Copy link
Member

jnothman commented Oct 5, 2016

Thanks @Ajackster

amueller pushed a commit to amueller/scikit-learn that referenced this pull request Oct 14, 2016
…ikit-learn#7560)

* Fixed search not expanding page

* Changed the comment to warn users why not to leave fixed height on header
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
…ikit-learn#7560)

* Fixed search not expanding page

* Changed the comment to warn users why not to leave fixed height on header
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
…ikit-learn#7560)

* Fixed search not expanding page

* Changed the comment to warn users why not to leave fixed height on header
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants