-
-
Notifications
You must be signed in to change notification settings - Fork 741
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
switch to default rtd theme #268
Conversation
this still doesn't quite work: our sidebar is gone, so no more useful links and related projects. we also loose the link to github and the RTD popup, although the latter still needs to be confirmed on RTD infra
another possible theme to consider: https://github.com/bitprophet/alabaster for sidebars, maybe something here? http://sphinx-doc.org/config.html#confval-html_sidebars it seems that we had custom sidebars that were shipped with our custom theme, not sure how to deal with that in the sphinx theme... maybe just move the sidebar to a new section? links.rst? |
for the logo: readthedocs/sphinx_rtd_theme#69 but it would need to be something else than green... |
sidebar issue: readthedocs/sphinx_rtd_theme#254 |
Current coverage is
|
alabaster seems to have some nice features, but is it responsive design to adapt to misc. devices / display sizes / dpi (that was one of the main reasons to move to rtd)? "fork me on github" is not essential, we can also just drop that. developers will know anyway. related links could be also put into README.rst, if sidebar extension isn't possible yet. |
On 2015-10-10 06:37:08, TW wrote:
i have no idea, would need to test / ask them. :)
agreed, i don't like that badge much anyways: "fork me" seems a little
okay then, maybe we can just start with that, it would be a good a.It will be a great day when our schools get all the money they need |
alabaster seems to have some issues with mobile for now: sphinx-doc/alabaster#57 and sphinx-doc/alabaster#44 - i'd suggest sticking with rtd for now. |
it seems sidebar links are not supported by the RTD theme just yet: readthedocs/sphinx_rtd_theme#254
Conflicts: README.rst
this makes it consistent with the rest of the documentation
i have added the sidebar links to the README, i'd suggest moving the question of the logo to a separate issue for now. otherwise this is ready to be merged, i updated my test copy with the new version: |
i did a quick test on my phone (6.4" FHD), looked good! except the travis and coverage buttons, which get huge (full width) when the window width is below some specific value. |
is that a blocker? :) |
no |
so i guess i'll just merge for now and create issues for the rest |
still TODO:
add sidebar / find solution for "related links" (support request upstream)- moved to README for nowadd back the "fork me on github" link?just dropping the link for nowconsider other themesalabaster doesn't support mobile devicesadd logo- needs a new logo, should probably be moved to a different issuethe results can be seen here for now:
http://borgbackup-anarcat.readthedocs.org/en/rtfd-debug/