linux-kernel - [RFC PATCH 2/3] doc-rst: customize RTD theme, table & full width

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Sun,  3 Jul 2016 14:24:54 +0200
From:	Markus Heiser <markus.heiser@...marit.de>
To:	unlisted-recipients:; (no To-header on input)
Cc:	Markus Heiser <markus.heiser@...marit.de>,
	Hans Verkuil <hverkuil@...all.nl>,
	Daniel Vetter <daniel.vetter@...ll.ch>,
	Airlie <airlied@...il.com>, Likely <grant.likely@...retlab.ca>,
	Dunlap <rdunlap@...radead.org>, Packard <keithp@...thp.com>,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	Markus Heiser <markus.heiser@...marIT.de>
Subject: [RFC PATCH 2/3] doc-rst: customize RTD theme, table & full width

From: Markus Heiser <markus.heiser@...marIT.de>
To: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab@....samsung.com>
Cc: Hans Verkuil <hverkuil@...all.nl>
Cc: Daniel Vetter <daniel.vetter@...ll.ch>
Cc: Airlie <airlied@...il.com>
Cc: Likely <grant.likely@...retlab.ca>
Cc: Dunlap <rdunlap@...radead.org>
Cc: Packard <keithp@...thp.com>
Cc: linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org

The default table layout of the RTD theme does not fit for vast tables,
like the ones we have in the linux_tv project. This has been discussed
on the ML [1].

The RTD theme is a two column layout, with a navigation column on the
left and a content column on the right:

content column

 RTD theme's default is 800px as max width for the content, but we have
 tables with tons of columns, which need the full width of the
 view-port (BTW: *full width* is what DocBook's HTML is).

table

   - sequences of whitespace should collapse into a single whitespace.
   - make the overflow auto (scrollbar if needed)
   - align caption "left" ("center" is unsuitable on vast tables)

[1] http://article.gmane.org/gmane.linux.kernel/2216509

Signed-off-by: Markus Heiser <markus.heiser@...marIT.de>
---
 Documentation/sphinx-static/theme_overrides.css | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
index 4d670db..ea06799 100644
--- a/Documentation/sphinx-static/theme_overrides.css
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -1,9 +1,28 @@
 /* -*- coding: utf-8; mode: css -*-
  *
- * Sphinx HTML theme customization
+ * Sphinx HTML theme customization: read the doc
  *
  */
 
 @media screen {
 
+    /* content column
+     *
+     * RTD theme's default is 800px as max width for the content, but we have
+     * tables with tons of columns, which need the full width of the view-port.
+     */
+
+    .wy-nav-content{max-width: none; }
+
+    /* table:
+     *
+     *   - Sequences of whitespace should collapse into a single whitespace.
+     *   - make the overflow auto (scrollbar if needed)
+     *   - align caption "left" ("center" is unsuitable on vast tables)
+     */
+
+    .wy-table-responsive table td { white-space: normal; }
+    .wy-table-responsive { overflow: auto; }
+    .rst-content table.docutils caption { text-align: left; font-size: 100%; }
+
 }
-- 
docs-next/sphinx-4.8