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

Why are we using the ugliest possible sphinx theme for the docs again? #3272

Closed
ghost opened this issue Apr 7, 2013 · 18 comments
Closed

Why are we using the ugliest possible sphinx theme for the docs again? #3272

ghost opened this issue Apr 7, 2013 · 18 comments
Labels
Milestone

Comments

@ghost
Copy link

ghost commented Apr 7, 2013

@wesm, any objection to changing over to "nature"?

@wesm
Copy link
Member

wesm commented Apr 7, 2013

None here.

@ghost
Copy link
Author

ghost commented Apr 7, 2013

done. fbc7109

@ghost ghost closed this as completed Apr 7, 2013
@wesm
Copy link
Member

wesm commented Apr 8, 2013

Have you looked at the new docs theme to assess it's usability? There's no navigation sidebar which was the whole point of the other theme. Ideas?

@wesm wesm reopened this Apr 8, 2013
@ghost
Copy link
Author

ghost commented Apr 8, 2013

I compiled the docs and opened them in a browser, I got a sidebar on the left with the topic TOC
instead of the older "chapters". you consider that a bad bargain?

docs

@ghost
Copy link
Author

ghost commented Apr 8, 2013

Modified the Sphinx theme to use the toc tree. pushed. also removed the OLS docs matching the code removed
earlier.

Can close?.

shot2

@ghost
Copy link
Author

ghost commented Apr 8, 2013

Also, switched to using the bundled mpl style, and made plot image size consistent
everywhere.

shot3

Huge improvement on both fronts IMO.

@jreback
Copy link
Contributor

jreback commented Apr 8, 2013

+1 on new layout and graphs

@changhiskhan
Copy link
Contributor

This is sweet. +1e6 for sane matplotlib defaults. I assume the new TOC layout navigates the same as before (except that it's on the left instead of the right)? I'm getting greedy but does the TOC scroll separately? Would be nice to have the TOC handy no matter where you are on the page.

@ghost
Copy link
Author

ghost commented Apr 8, 2013

it's a a canned template macro provided by sphinx, I just mashed up
agogo (the prev theme) with the new one and went through the
"pixel alignment boogie" for an hour.

Pretty easy to make the TOC div position:fixed, but maybe better to have it fold away and back,
freeing up screen real-estate.
as you know the previous template (customized?) had a tendency for the TOC to occlude the content,
putting the TOC on the left does a better job I think.

@jreback
Copy link
Contributor

jreback commented Apr 8, 2013

I think maybe the menu should move as well....can you post what I would need to change to try it?

@ghost
Copy link
Author

ghost commented Apr 8, 2013

+1 *2 is good enough for me. I'll take care of it.

@ghost
Copy link
Author

ghost commented Apr 8, 2013

Done. with a little flare for good measure. a625fbd

@ghost ghost closed this as completed Apr 8, 2013
@hayd
Copy link
Contributor

hayd commented Apr 8, 2013

This is great!

@ghost ghost reopened this Apr 8, 2013
@ghost
Copy link
Author

ghost commented Apr 8, 2013

But it breaks (UX wise) when the bottom TOC entries are off the viewport.
Don't think we can keep this.

Thanks @hayd.

@hayd
Copy link
Contributor

hayd commented Apr 8, 2013

@y-p off the viewport?

@ghost
Copy link
Author

ghost commented Apr 8, 2013

The visible portion of the document.

pushed a fix, sticky everywhere except the API page.

@ghost ghost closed this as completed Apr 8, 2013
@ghost
Copy link
Author

ghost commented Apr 8, 2013

I reverted back to the regular "TOC scrolls off the screen" behaviour, there are several
items which don't fit on the screen and it's not worth the hassle to handle that properly.
So I'm settling for the old theme's behvaior, only looking much better.

If anyone wants to take a trip down javascript lane, be my guest.

@wesm
Copy link
Member

wesm commented Apr 9, 2013

Thanks @y-p

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants