linux-kernel - [RFC PATCH 3/3] doc-rst: customize RTD theme, captions & inline literal

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]

Message-Id: <1467548695-16403-4-git-send-email-markus.heiser@darmarit.de>
Date:	Sun,  3 Jul 2016 14:24:55 +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 3/3] doc-rst: customize RTD theme, captions & inline literal

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 layout of (table) captions in the RTD theme is a bit ugly and the
bordered, red colored of inline literals is a bit to gaudy. The
requirements has been discussed in the ML [1].

captions:

  - captions should have 100% (not 85%) font size
  - hide the permalink symbol as long as link is not hovered

inline literal:

  - drop the borderbox and red color

[1] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099

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

diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
index ea06799..c97d842 100644
--- a/Documentation/sphinx-static/theme_overrides.css
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -25,4 +25,29 @@
     .wy-table-responsive { overflow: auto; }
     .rst-content table.docutils caption { text-align: left; font-size: 100%; }
 
+    /* captions:
+     *
+     *   - captions should have 100% (not 85%) font size
+     *   - hide the permalink symbol as long as link is not hovered
+     */
+
+    caption, .wy-table caption, .rst-content table.field-list caption {
+        font-size: 100%;
+    }
+    caption a.headerlink { opacity: 0; }
+    caption a.headerlink:hover { opacity: 1; }
+
+    /* inline literal: drop the borderbox and red color */
+
+    code, .rst-content tt, .rst-content code {
+        color: inherit;
+        border: none;
+        background: inherit;
+        font-size: 85%;
+    }
+
+    .rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal {
+        color: inherit;
+    }
+
 }
-- 
docs-next/sphinx-4.8