search

Freeseer / freeseer

Designed for capturing presentations at conferences. Pre-fill a list of talks to record, record them, and upload them to YouTube with our YouTube Uploader.
http://freeseer.readthedocs.org
GNU General Public License v3.0
215 stars 110 forks source link

Switch docs to bootstrap theme? #596

Closed dideler closed 9 years ago

dideler commented 9 years ago

https://github.com/ryan-roemer/sphinx-bootstrap-theme

zxiiro commented 9 years ago

+1

An improved theme would make our docs look really nice.

umcsdon commented 9 years ago

Assign this one to me. Thx!

zxiiro commented 9 years ago

@umcsdon I sent you an invite to be added to a Freeseer team, we need to do this to be able to assign issues to you. Once you accept we can assign the issue. Thanks.

umcsdon commented 9 years ago

Hi, @dideler @zxiiro . I have the initial version ready, take a look at here.

Any additional changes required? The commit can be found in my forked version with branch name: 596-bootstrap-theme.

Note: #571 problem still exists

mtomwing commented 9 years ago

Was there any custom CSS added to the bootstrap theme? It doesn't really feel like standard bootstrap.

Maybe something like this would look better.

umcsdon commented 9 years ago

Hi, @mtomwing . I didn't add any custom CSS written by me for this initial implementation.

However, I'm using the Flatly theme from bootswatch.com (Link)

umcsdon commented 9 years ago

Hi, @mtomwing. I think you are talking about sphinx_rtd_theme.

@dideler @zxiiro Which theme should we use?

zxiiro commented 9 years ago

@umcsdon Hey thanks a lot for jumping on this one!

After taking a look at both themes I'm leaning towards the sphinx_rtd_theme. I feel like it fits more naturally with the flow of reading docs than the sphinx-bootstrap-theme.

umcsdon commented 9 years ago

@zxiiro Sphinx_rtd_theme version is ready! Link

Any additional changes required?

mtomwing commented 9 years ago

@umcsdon if we build the docs locally, do we also get this theme?

umcsdon commented 9 years ago

@mtomwing I've added sphinx_rtd_theme to requirements.txt. After running pip install -r requirements.txt, you should able to see the changes.

You can checkout my forked version to see it.

mtomwing commented 9 years ago

Would be easier to see in a pull request.

umcsdon commented 9 years ago

@mtomwing Pull request ready.

dideler commented 9 years ago

+1 to the RTD theme, looks pretty good. Only drawback is that it looks like every other RTD site, but that's not a big deal.

dideler commented 9 years ago

Curious, does the styling of the navigation look different for anyone else when viewing the RTD theme locally?

Online image

Local image

umcsdon commented 9 years ago

@dideler I have the same problem.

umcsdon commented 9 years ago

@dideler I found the problem for the display color issue. In ../_template/layout.html, we manually set the color for a few tags.

I think this problem also explains the footer bug on the buildthedocs site, the ../_template/layout.html gets ignored there.

umcsdon commented 9 years ago

@dideler Should I remove those custom styling?

dideler commented 9 years ago

@umcsdon sure, give it a try. Those custom styles are specific to the current theme, so they won't be necessary if we switch themes.