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

switch to default rtd theme #268

Merged
merged 4 commits into from
Oct 13, 2015
Merged

switch to default rtd theme #268

merged 4 commits into from
Oct 13, 2015

Conversation

anarcat
Copy link
Contributor

@anarcat anarcat commented Oct 9, 2015

still TODO:

  • add sidebar / find solution for "related links" (support request upstream) - moved to README for now
  • add back the "fork me on github" link? just dropping the link for now
  • consider other themes alabaster doesn't support mobile devices
  • add logo - needs a new logo, should probably be moved to a different issue

the results can be seen here for now:

http://borgbackup-anarcat.readthedocs.org/en/rtfd-debug/

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
@anarcat
Copy link
Contributor Author

anarcat commented Oct 9, 2015

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?

@anarcat
Copy link
Contributor Author

anarcat commented Oct 9, 2015

for the logo: readthedocs/sphinx_rtd_theme#69 but it would need to be something else than green...

@anarcat
Copy link
Contributor Author

anarcat commented Oct 9, 2015

sidebar issue: readthedocs/sphinx_rtd_theme#254

@anarcat anarcat self-assigned this Oct 9, 2015
@codecov-io
Copy link

Current coverage is 83.13%

Merging #268 into master will not affect coverage as of a24663c

@@            master    #268   diff @@
======================================
  Files           31      31       
  Stmts         6748    6748       
  Branches         0       0       
  Methods          0       0       
======================================
  Hit           5610    5610       
  Partial          0       0       
  Missed        1138    1138       

Review entire Coverage Diff as of a24663c


Uncovered Suggestions

  1. +0.62% via borg/fuse.py#126...167
  2. +0.50% via borg/xattr.py#199...232
  3. +0.43% via borg/xattr.py#166...194
  4. See 7 more...

Powered by Codecov. Updated on successful CI builds.

@ThomasWaldmann
Copy link
Member

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.

@anarcat
Copy link
Contributor Author

anarcat commented Oct 10, 2015

On 2015-10-10 06:37:08, TW wrote:

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)?

i have no idea, would need to test / ask them. :)

"fork me on github" is not essential, we can also just drop that. developers will know anyway.

agreed, i don't like that badge much anyways: "fork me" seems a little
ironic considering the history of borg... ;)

related links could be also put into README.rst, if sidebar extension isn't possible yet.

okay then, maybe we can just start with that, it would be a good
addition to the README anyways.

a.

It will be a great day when our schools get all the money they need
and the air force has to hold a bake sale to buy a bomber.
- Unknown

@anarcat
Copy link
Contributor Author

anarcat commented Oct 13, 2015

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
this makes it consistent with the rest of the documentation
@anarcat
Copy link
Contributor Author

anarcat commented Oct 13, 2015

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:

http://borgbackup-anarcat.readthedocs.org/en/rtfd-debug/

@ThomasWaldmann
Copy link
Member

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.

@anarcat
Copy link
Contributor Author

anarcat commented Oct 13, 2015

except the travis and coverage buttons, which get huge (full width) when the window width is below some specific value.

is that a blocker? :)

@ThomasWaldmann
Copy link
Member

no

@anarcat
Copy link
Contributor Author

anarcat commented Oct 13, 2015

so i guess i'll just merge for now and create issues for the rest

anarcat added a commit that referenced this pull request Oct 13, 2015
switch to default rtd theme
@anarcat anarcat merged commit 97a9855 into borgbackup:master Oct 13, 2015
@anarcat anarcat deleted the rtd-theme branch October 13, 2015 12:27
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.

3 participants