Skip to contentSkip to conversation

docs: improve readability for people with poorer eyesight

PATCH In review Darrick J. Wong 3 participants 3 messages Oct 5, 2018 – Oct 7, 2018 Documentation

lore
Share & tools
lore

Darrick J. Wong

author
#0 lore raw

PATCH 1/1 docs: improve readability for people with poorer eyesight

Hi,

So my eyesight still hasn't fully recovered, so in the meantime it's been difficult to read the online documentation. Here's some stylesheet overrides I've been using to make it easier for me to read them:
https://djwong.org/docs/kdoc/index.html

---
From: Darrick J. Wong <[email protected]>

My eyesight is not in good shape, which means that I have difficulty reading the online Linux documentation. Specifically, body text is oddly small compared to list items and the contrast of various text elements is too low for me to be able to see easily.

Therefore, alter the HTML theme overrides to make the text larger and increase the contrast for better visibility, and trust the typeface choices of the reader's browser.

For the PDF output, increase the text size, use a sans-serif typeface for sans-serif text, and use a serif typeface for "roman" serif text.

Signed-off-by Darrick J. Wong <[email protected]>
---
 Documentation/conf.py                           |    6 ++--
 Documentation/sphinx-static/theme_overrides.css |   38 +++++++++++++++++++++++
 2 files changed, 41 insertions(+), 3 deletions(-)
Documentation/conf.py +3 -3
index e45d4d2b5adb..03dd6dc135ea 100644
@@ -259,7 +259,7 @@ latex_elements = {
 'papersize': 'a4paper',
 
 # The font size ('10pt', '11pt' or '12pt').
-'pointsize': '8pt',
+'pointsize': '11pt',
 
 # Latex figure (float) alignment
 #'figure_align': 'htbp',

@@ -272,8 +272,8 @@ latex_elements = {
     'preamble': '''
 	% Use some font with UTF-8 support with XeLaTeX
         \\usepackage{fontspec}
-        \\setsansfont{DejaVu Serif}
-        \\setromanfont{DejaVu Sans}
+        \\setsansfont{DejaVu Sans}
+        \\setromanfont{DejaVu Serif}
         \\setmonofont{DejaVu Sans Mono}
 
      '''
Documentation/sphinx-static/theme_overrides.css +38 -0
index 522b6d4c49d4..e21e36cd6761 100644
@@ -4,6 +4,44 @@
  *
  */
 
+/* Improve contrast and increase size for easier reading. */
+
+body {
+	font-family: serif;
+	color: black;
+	font-size: 100%;
+}
+
+h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
+	font-family: sans-serif;
+}
+
+.wy-menu-vertical li.current a {
+	color: #505050;
+}
+
+.wy-menu-vertical li.on a, .wy-menu-vertical li.current > a {
+	color: #303030;
+}
+
+div[class^="highlight"] pre {
+	font-family: monospace;
+	color: black;
+	font-size: 100%;
+}
+
+.wy-menu-vertical {
+	font-family: sans-serif;
+}
+
+.c {
+	font-style: normal;
+}
+
+p {
+	font-size: 100%;
+}
+
 /* Interim: Code-blocks with line nos - lines and line numbers don't line up.
  * see: https://github.com/rtfd/sphinx_rtd_theme/issues/419
  */
Acked-by on v1 1/1
#1 lore raw
Quoted 15 lines · Darrick J. Wong

Hi,

So my eyesight still hasn't fully recovered, so in the meantime it's been difficult to read the online documentation. Here's some stylesheet overrides I've been using to make it easier for me to read them:
https://djwong.org/docs/kdoc/index.html

---
From: Darrick J. Wong <[email protected]>

My eyesight is not in good shape, which means that I have difficulty reading the online Linux documentation. Specifically, body text is oddly small compared to list items and the contrast of various text elements is too low for me to be able to see easily.

Quoted 8 lines

Therefore, alter the HTML theme overrides to make the text larger and increase the contrast for better visibility, and trust the typeface choices of the reader's browser.

For the PDF output, increase the text size, use a sans-serif typeface for sans-serif text, and use a serif typeface for "roman" serif text.

Signed-off-by Darrick J. Wong <[email protected]>

This fixes problems I noticed when trying to review the built html documentation - the inconsistent font sizes on my high-dpi monitor made it almost impossible to read even though I have no eyesight problems....

Acked-by Dave Chinner <[email protected]>

-Dave.

Signature · 2 lines
Dave Chinner
[email protected]
maintainer
#2 lore raw
In reply to Darrick J. Wong
Quoted 13 lines · On Thu, 4 Oct 2018 18:06:03 -0700 "Darrick J. Wong" <[email protected]>…

o my eyesight still hasn't fully recovered, so in the meantime it's been difficult to read the online documentation. Here's some stylesheet overrides I've been using to make it easier for me to read them:
https://djwong.org/docs/kdoc/index.html

---
From: Darrick J. Wong <[email protected]>

My eyesight is not in good shape, which means that I have difficulty reading the online Linux documentation. Specifically, body text is oddly small compared to list items and the contrast of various text elements is too low for me to be able to see easily.

Quoted 8 lines

Therefore, alter the HTML theme overrides to make the text larger and increase the contrast for better visibility, and trust the typeface choices of the reader's browser.

For the PDF output, increase the text size, use a sans-serif typeface for sans-serif text, and use a serif typeface for "roman" serif text.

Signed-off-by Darrick J. Wong <[email protected]>

I've been wanting to find some time to work on our stylesheets for years; what we have now is far from ideal (or attractive) IMO. This is a good step in the right direction - applied, thanks.

jon