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.

Sign up for GitHub

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

Jump to bottom

docs: change theme to furo #1564

Merged
merged 33 commits into from Jul 6, 2022
Merged

docs: change theme to furo #1564

merged 33 commits into from Jul 6, 2022

Conversation

dcfidalgo
Copy link
Contributor

@dcfidalgo dcfidalgo commented Jun 15, 2022 •
edited

@dcfidalgo dcfidalgo self-assigned this Jun 15, 2022
@dcfidalgo dcfidalgo added the type: documentation Improvements or additions to documentation label Jun 15, 2022
@dcfidalgo dcfidalgo added this to In progress in Release via automation Jun 15, 2022
@dcfidalgo
Copy link
Contributor Author

dcfidalgo commented Jun 21, 2022 •
edited

TODO:

  • fix dependencies for everything

@dcfidalgo dcfidalgo force-pushed the docs/change_theme_to_furo branch 2 times, most recently from 7319f26 to 1d111e7 Compare June 21, 2022 14:01
@dcfidalgo dcfidalgo marked this pull request as ready for review June 21, 2022 14:01
@dcfidalgo dcfidalgo linked an issue Jul 5, 2022 that may be closed by this pull request
[Sphinx theme] Docu theme change #1512
Closed
@dcfidalgo dcfidalgo removed a link to an issue Jul 5, 2022
[Sphinx theme] Docu theme change #1512
Closed
@leiyre leiyre mentioned this pull request Jul 5, 2022
Closed
@frascuchon frascuchon linked an issue Jul 5, 2022 that may be closed by this pull request
[Sphinx theme] Docu theme change #1512
Closed
@frascuchon frascuchon removed this from In progress in Release Jul 5, 2022
@Amelie-V
Copy link
Member

Amelie-V commented Jul 5, 2022 •
edited

UI QA

Desktop - TOC

  • Up TOC font size to 14 px.

  • Use grey #484848 for hover and active style link. Add it on hover too

  • Change BG color of active anchor (yellow highlight) to grey (same grey than used in highlight sidebar

  • Write CONTENTS like this "Contents" and use the blue #4C4EA3

  • Change # for the previous icon.

  • Add effect hover to the TOC (use the active state style).

Dark mode

  • Menu titles in White
  • Link style : white, underlined. maintain light purple on hover
  • Add white BG to images
  • BG menu: apply the same grey BG (instead of black)
  • Show separation line
  • Hover and active styles : bold font
  • En mobile: show hamb. menu and Search icon on white

Code area

  • Apply "Material"
  • Adapt padding
  • If necessary change "material" BG color to a lighter grey

Table

  • Align header to the left

Layout

  • Center layout
  • Adapt sidebar padding, just like in previous vs
  • Reduce anchor central column
  • Active 3 and 2 columns layout (without TOC)
  • Quit "made with sphynx..."
  • Center logo vertically ( add space on top of it)
  • Move star plugin to the right side, close to the icon mode

General

  • Dark mode : show "Content" in white
  • Search mode: improve contrast. L.M : "Search" in blue color link D.M: "Search" in white color (instead of grey)
  • Remove scroll bar
  • Add Padding around img, Code area, info block
  • Padding around code is still not affecting all the code areas
  • Lighter the pink of "Inline code block" and "Title Inline code block"
  • Remove BG from anchors

leiyre and others added 18 commits July 5, 2022 14:55
@leiyre
Merge branch 'docs/change_theme_to_furo' of https://github.com/recogn…
bbd8de3 
…ai/rubrix into docs/change_theme_to_furo
@leiyre
remove img padding
f89db2e
@leiyre
copy button and button-to-top styles
f34dd8a
@leiyre
remove copy button hover
e4d0e03
@leiyre
more contrast page-info link
9fd5637
@leiyre
hide "#" on click title
5731801
@leiyre
sidebar current page color
8a7cc0c
@leiyre
sidebar caption color
65289b3
docs: remove superfluous toc from dataset reference page
d3d6ad9
@leiyre
searchbox light mode
456f040
@leiyre
Merge branches 'docs/change_theme_to_furo' and 'docs/change_theme_to_…
1822085 
…furo' of https://github.com/recognai/rubrix into docs/change_theme_to_furo
@leiyre
toc-title
44f204c
@leiyre
mobile center stars
2845ce6
@leiyre
searchbox and h1
825e13e
@leiyre
h2 font weight
a165ca0
docs: fix link
46b57ab
docs: fix reference
0150e74
docs: fix dependencies
f0f488b
@dcfidalgo dcfidalgo added this to In progress in Release via automation Jul 6, 2022
@dcfidalgo dcfidalgo merged commit 99f2547 into master Jul 6, 2022
@dcfidalgo dcfidalgo deleted the docs/change_theme_to_furo branch July 6, 2022 15:02
Release automation moved this from In progress to Waiting Release Jul 6, 2022
@frascuchon frascuchon removed this from Waiting Release in Release Jul 6, 2022
frascuchon added a commit that referenced this pull request Jul 7, 2022
@frascuchon
docs: change theme to furo (#1564)
efe606c 
(cherry picked from commit 99f2547)

feat(#1512): improve TOC in Documentation (#1604)

(cherry picked from commit ee3b750)
frascuchon added a commit that referenced this pull request Jul 7, 2022
@frascuchon
docs(#1512): change theme to furo (#1564)
048469e 
(cherry picked from commit 99f2547)

style: improve TOC in Documentation (#1604)

(cherry picked from commit ee3b750)
frascuchon added a commit that referenced this pull request Jul 8, 2022
@frascuchon
docs(#1512): change theme to furo (#1564)
6c7291c 
(cherry picked from commit 99f2547)

style: improve TOC in Documentation (#1604)

(cherry picked from commit ee3b750)
frascuchon added a commit that referenced this pull request Jul 8, 2022
@frascuchon
docs(#1512): change theme to furo (#1564)
5078e5a 
(cherry picked from commit 99f2547)

style: improve TOC in Documentation (#1604)

(cherry picked from commit ee3b750)
frascuchon added a commit that referenced this pull request Jul 8, 2022
@frascuchon
docs(#1512): change theme to furo (#1564, #1604)
98869d2 
(cherry picked from commit 99f2547)

style: improve TOC in Documentation

(cherry picked from commit ee3b750)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@dcfidalgo dcfidalgo

Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Sphinx theme] Docu theme change
3 participants
@dcfidalgo @Amelie-V @leiyre